Limits list - Freedom Pay

This method is used to retrieve a list of all active limits set for a specific object: a card, account, or client.
The response returns a complete list of currently active limits, including:
the transaction type (e.g., pay, withdrawal, pay_online_non3ds)
the limit period (day, month)
the maximum allowed amount
the currency in which the limit is set
the current counter value, indicating how much has already been used within the limit for the given period
the available remaining amount, showing how much is still available within the limit
and other parameters
This allows clients to receive not only the limits themselves, but also real-time information about their current usage.

Request

Body Params application/json

request_id

string

required

Unique request ID in the partner system (UUID).

object

required

The object for which the list of limits is requested.

type

string

required

Type of the object. Possible values: card, account, client.

value

string

required

Identifier of the object.

Example

{
  "request_id": "123e4567-e89b-12d3-a456-426614174000",
  "object": {
    "type": "card",
    "value": "123456789"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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.

limits

object

required

Limits information

product

array [object {6}]

required

Limits set at the product level (not editable).

card

array [object {6}]

optional

Limits set at the card level (editable).

string

required

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

Example

{
    "status": "string",
    "request_status": "string",
    "limits": {
        "product": [
            {
                "id": "string",
                "transaction_type": "string",
                "mcc": "string",
                "region": "string",
                "period": "string",
                "amount": [
                    {
                        "type": "string",
                        "value": "string",
                        "current": "string",
                        "remaining": "string",
                        "currency": "string"
                    }
                ]
            }
        ],
        "card": [
            {
                "id": "string",
                "transaction_type": "string",
                "mcc": "string",
                "region": "string",
                "period": "string",
                "amount": [
                    {
                        "type": "string",
                        "value": "string",
                        "current": "string",
                        "remaining": "string",
                        "currency": "string"
                    }
                ]
            }
        ]
    },
    "dt": "string"
}