Statement extended - Freedom Pay

The Statement Extended method is used to retrieve a detailed statement for a payment card issued within the Freedom Processing system. Compared to the standard Statement method, it provides additional information on accounts, available balances, and clearly separates authorization holds from completed transactions.

Request

Body Params application/json

card_id

string

required

Identifier of the card in Freedom Processing.

start_date

string

required

Start date and time of the statement period in RFC 3339 format (YYYY-MM-DDThh:mm:ss+hh:mm).

end_date

string

required

End date and time of the statement period in RFC 3339 format (YYYY-MM-DDThh:mm:ss+hh:mm).

Example

{
  "card_id": "string",
  "start_date": "string",
  "end_date": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

status

string

optional

Indicates the status of the request. Possible values: ok - request successful, error - request failed.

request_status

string

optional

Indicates the execution status of the request. Refer to the documentation.

client_id

string

optional

Identifier of the client in Freedom Processing.

card

object

optional

Information about the card.

card_id

string

optional

Identifier of the card in Freedom Processing.

card_mask

string

optional

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

balances

object

optional

Array of information about balances.

accounts

array [object {6}]

optional

Array of information about accounts.

iban

string

optional

Account number.

currency

string

optional

Currency (alpha-3 code).

debit

integer

optional

The amount debited from the account.

credit

integer

optional

The amount credited to the account.

amount

number

optional

Available balance.

blocked_amount

integer | number

optional

Blocked balance.

authorizations

array [object {10}]

optional

Array of authorizations data.

datetime

string

optional

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

type

string

optional

Type of the authorization. Refer to transaction type reference.

amount

number

optional

Authorization amount.

commission

number

optional

Authorization commission amount.

full_amount

number

optional

Authorization full amount.

cashback

number

optional

Cashback amount.

currency

string

optional

Currency (alpha-3 code).

iban

string

optional

Account number.

merchant

object

optional

Merchant details.

additional_parameters

array [object {2}]

optional

Additional authorization details.

operations

array [object {10}]

optional

Array of operations data.

datetime

string

optional

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

type

string

optional

Type of the operation. Refer to transaction type reference.

amount

number

optional

Operation amount.

commission

number

optional

Operation commission amount.

full_amount

number

optional

Operation full amount.

cashback

number

optional

Cashback amount.

currency

string

optional

Currency (alpha-3 code).

iban

string

optional

Account number.

merchant

object

optional

Merchant details.

additional_parameters

array [object {2}]

optional

Additional operation details.

string

optional

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

Example

{
  "status": "ok",
  "request_status": "success",
  "client_id": "347942915",
  "card": {
    "card_id": "2422900000000751280",
    "card_mask": "1234-56XX-XXXX-4321",
    "balances": {
      "currency": "TJS",
      "available_amount": 14622.11,
      "blocked_amount": 0
    }
  },
  "accounts": [
    {
      "iban": "12345678912345678911",
      "currency": "USD",
      "debit": 0,
      "credit": 0,
      "amount": 1369.89,
      "blocked_amount": 0
    },
    {
      "iban": "12345678912345678912",
      "currency": "KZT",
      "debit": 0,
      "credit": 100,
      "amount": 696291.18,
      "blocked_amount": 105.5
    },
    {
      "iban": "12345678912345678913",
      "currency": "RUB",
      "debit": 0,
      "credit": 0,
      "amount": 133426.25,
      "blocked_amount": 0
    },
    {
      "iban": "12345678912345678914",
      "currency": "CNY",
      "debit": 0,
      "credit": 0,
      "amount": 9946.95,
      "blocked_amount": 0
    },
    {
      "iban": "12345678912345678915",
      "currency": "AED",
      "debit": 0,
      "credit": 0,
      "amount": 5042.03,
      "blocked_amount": 0
    },
    {
      "iban": "12345678912345678916",
      "currency": "TRY",
      "debit": 0,
      "credit": 0,
      "amount": 47167.86,
      "blocked_amount": 0
    },
    {
      "iban": "12345678912345678917",
      "currency": "EUR",
      "debit": 0,
      "credit": 0,
      "amount": 1306.79,
      "blocked_amount": 0
    }
  ],
  "authorizations": [
    {
      "datetime": "2025-01-30T12:02:14+05:00",
      "type": "1059",
      "amount": 100,
      "commission": 0,
      "full_amount": 100,
      "cashback": 1,
      "currency": "KZT",
      "iban": "12345678912345678912",
      "merchant": {
        "name": "Shop 1",
        "country": "KAZ",
        "address_line1": "ALMATY",
        "postal_code": "",
        "url": ""
      },
      "additional_parameters": [
        {
          "type": "cashback_amount",
          "value": "0.00"
        }
      ]
    }
  ],
  "operations": [
    {
      "datetime": "2025-02-01T12:56:35+05:00",
      "type": "KA",
      "amount": 561.71,
      "commission": 0,
      "full_amount": 561.71,
      "cashback": 1,
      "currency": "TJS",
      "iban": "12345678912345678918",
      "merchant": {
        "name": "Standing payment order",
        "country": "",
        "address_line1": "",
        "postal_code": "",
        "url": ""
      },
      "additional_parameters": [
        {
          "type": "cashback_amount",
          "value": "0.00"
        }
      ]
    },
    {
      "datetime": "2025-01-22T15:48:35+05:00",
      "type": "1054",
      "amount": 0,
      "commission": 0.32,
      "full_amount": 0.32,
      "cashback": 1,
      "currency": "TJS",
      "iban": "12345678912345678918",
      "merchant": {
        "name": "PVN TEST Shop 1",
        "country": "TJK",
        "address_line1": "ALMATY",
        "postal_code": "",
        "url": ""
      },
      "additional_parameters": [
        {
          "type": "cashback_amount",
          "value": "0.00"
        }
      ]
    }
  ],
  "dt": "2025-02-06T06:50:57Z"
}