Freedom Pay

Card list

POST

https://api.freedompay.kg/v5/card-api/client/cards/list

Request

Body Params application/json

request_id

string

required

Unique request ID in the partner system (UUID).

client_id

string

required

Identifier of the client 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.kg/v5/card-api/client/cards/list' \
--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.

cards

array [object {9}]

required

Array with the client's card data.

card_id

string

required

Identifier of the card in Freedom Processing.

product_id

integer

required

Product code of the card.

card_mask

string

required

Masked card number (partially hidden digits). Example: 5483-18XX-XXXX-0293.

card_month

integer

required

Expiration month of the card. Two digits.

card_year

integer

required

Expiration year of the card. Two digits.

first_name

string

required

Cardholder's first name.

last_name

string

required

Cardholder's last name.

status

string

required

Status of the card.

balances

array [object {4}]

required

Array of balance information.

string

required

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

Example

{
  "status": "string",
  "request_status": "string",
  "cards": [
    {
      "card_id": "string",
      "product_id": 0,
      "card_mask": "string",
      "card_month": 0,
      "card_year": 0,
      "first_name": "string",
      "last_name": "string",
      "status": "string",
      "balances": [
        {
          "iban": "string",
          "currency": "string",
          "amount": 0,
          "blocked_amount": 0
        }
      ]
    }
  ],
  "dt": "string"
}

Modified at 2025-02-03 10:08:06

Edit

Request status