GET - Card Balance

Fetch the list of spend rules associated with the card identified by the cardId path parameter.

Get - Card Balance

---

End point

https://api.up.money/cards/balance/{cardId}

Headers

Security

REQUEST BODY SCHEMA: application/json

🔐 API SECRET: x-secret

Add YWJjMTIzIQ== in x-secret in headers.

Header parameter name: x-secret

---

🔏 HTTP: Authorization-key

The authentication token representing the user. This will be included in the login response object as token.

Header parameter name: Authorization-key

---

Path Parameters

---

id (required)	string ^[0-9]+$ The unique identifier of a card.

---

Sample Request

---

curl --location 'https://api.up2.money/cards/balance/{cardId}' \
--header 'x-secret: YWJjMTIzIQ==' \
--header 'Authorization-key: YOUR_AUTHORIZATION_KEY' \
--data ''

---

Sample Response

---

Success - 200

{
  "allowedMerchantCategories": [
    "string"
  ],
  "blockedMerchantCategories": [
    "string"
  ],
  "allowedMerchantIds": [
    "string"
  ],
  "blockedMerchantIds": [
    "string"
  ],
  "allowedMerchantCountries": [
    "st"
  ],
  "blockedMerchantCountries": [
    "st"
  ],
  "allowContactless": true,
  "allowAtm": true,
  "allowECommerce": true,
  "allowCashback": true,
  "allowCreditAuthorisations": true,
  "minTransactionAmount": 0,
  "maxTransactionAmount": 0,
  "spendLimit": [
    {
      "value": {
        "currency": "str",
        "amount": 0
      },
      "interval": "DAILY"
    }
  ],
  "cardLevelSpendRules": {
    "allowedMerchantCategories": [
      "string"
    ],
    "blockedMerchantCategories": [
      "string"
    ],
    "allowedMerchantIds": [
      "string"
    ],
    "blockedMerchantIds": [
      "string"
    ],
    "allowedMerchantCountries": [
      "st"
    ],
    "blockedMerchantCountries": [
      "st"
    ],
    "allowContactless": true,
    "allowAtm": true,
    "allowECommerce": true,
    "allowCashback": true,
    "allowCreditAuthorisations": true,
    "spendLimit": [
      {
        "value": {
          "currency": "str",
          "amount": 0
        },
        "interval": "DAILY"
      }
    ],
    "minTransactionAmount": 0,
    "maxTransactionAmount": 0
  },
  "profileLevelSpendRules": {
    "allowedMerchantCategories": [
      "string"
    ],
    "blockedMerchantCategories": [
      "string"
    ],
    "allowedMerchantIds": [
      "string"
    ],
    "blockedMerchantIds": [
      "string"
    ],
    "allowedMerchantCountries": [
      "st"
    ],
    "blockedMerchantCountries": [
      "st"
    ],
    "allowContactless": true,
    "allowAtm": true,
    "allowECommerce": true,
    "allowCashback": true,
    "allowCreditAuthorisations": true,
    "authForwardingEnabled": true
  },
  "identityLevelSpendRules": {
    "allowedMerchantCategories": [
      "string"
    ],
    "blockedMerchantCategories": [
      "string"
    ],
    "allowedMerchantIds": [
      "string"
    ],
    "blockedMerchantIds": [
      "string"
    ],
    "allowedMerchantCountries": [
      "st"
    ],
    "blockedMerchantCountries": [
      "st"
    ],
    "allowContactless": true,
    "allowAtm": true,
    "allowECommerce": true,
    "allowCashback": true,
    "allowCreditAuthorisations": true,
    "minTransactionAmount": 0,
    "maxTransactionAmount": 0
  }
}

Error - 400

---

Response Status

---

200 Success

400 Bad Request Error - Your request is invalid.

errorCode: Enum: "REQUIRED" "HAS_TEXT" "REQUIRES" "SIZE" "RANGE" "IN" "NOT_IN" "REGEX" "EXACTLY" "AT_LEAST" "AT_MOST" "ALL_OR_NONE"

400 Bad Request Error - Your request is invalid.

401 Unauthorized - Your credentials or access token are invalid.

403 Forbidden - Access to the requested resource or action is forbidden.

429 Too many requests.

500 Internal Server Error - There is a problem with the server. Please try again later.

503 Service Unavailable - We're temporarily offline for maintenance. Please try again later.