Balance

POST

https://api.freedompay.kz/v5/card-api/card/balance

The method is designed to retrieve up-to-date information about the available funds on a payment card. It allows users to check the current status of all accounts, available and blocked amounts, as well as balances considering other currency accounts.

Request

Body Params application/json

card_id

string

required

Identifier of the card in Freedom Processing.

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/v5/card-api/card/balance' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success

application/json

Body

status

string

required

Status of the request. Possible values:

ok: Request completed successfully.

error: Request completed with an error.

request_status

string

required

Execution status of the request. Refer to the documentation.

balances

array [object {6}]

required

Array with balance information.

iban

string

required

Account number.

currency

string

required

Currency (alpha-3 code).

amount

number

required

Available balance in the account's currency without considering balances in other currencies.

linked_amount

number

required

Available balance for combining with other accounts in different currencies, converted to the account's currency.

available_amount

number

required

Total available balance in the account's currency, including linked amounts. Calculated as amount + linked_amount.

blocked_amount

number

required

Blocked balance in the account's currency.

string

required

Date and time of the request (format: RFC 3339, YYYY-MM-DDThh:mm:ss+hh:mm).

Example

{
  "status": "string",
  "request_status": "string",
  "balances": [
    {
      "iban": "string",
      "currency": "string",
      "amount": 0,
      "linked_amount": 0,
      "available_amount": 0,
      "blocked_amount": 0
    }
  ],
  "dt": "string"
}

Modified at 2025-03-01 07:08:06

Card info

Secret data