Freedom Pay

Balance

POST

https://api.freedompay.kz/v5/partner/wallet/balance

Request

Body Params application/json

identifier

string

required

Unique wallet identifier in the partner's system.

Example

{
    "identifier": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/v5/partner/wallet/balance' \
--header 'Content-Type: application/json' \
--data-raw '{
    "identifier": "string"
}'

Responses

🟢200Success

application/json

Body

status

string

required

Indicates the status of the request:

ok: Request completed successfully.

error: Request failed with an error.

request_status

string

required

Execution status of the request. Refer to the status guide.

balance

object

required

Object with balance information.

currency

string

required

Wallet currency (alpha-3).

amount

number

required

Available balance.

string <date-time>

required

Date and time of the request in RFC 3339 format.
Format: YYYY-MM-DDThh:mm:ss+hh:mm.

error_code

string

optional

Error code ID. Returned only in case of errors.

error_description

string

optional

Text description of the error. Returned only in case of errors.

Example

{
    "status": "string",
    "request_status": "string",
    "balance": {
        "currency": "string",
        "amount": 0
    },
    "dt": "2019-08-24T14:15:22Z",
    "error_code": "string",
    "error_description": "string"
}

Modified at 2025-01-06 10:29:54

Block

Statement