Set limits

POST

https://api.freedompay.kz/v5/card-api/limits/set

The method is designed to set limits on financial operations for a specific object — a card, account, or client. Limits allow controlling and restricting a user's financial activity in various scenarios: by transaction type, period, currency, and transaction method (e.g., with or without 3DS authentication).
For example, for a card ("type": "card"), you can set a maximum limit ("type": "max") on the amount of cash withdrawals at ATMs ("transaction_type": "withdrawal_atm") per month ("period": "month").

Request

Body Params application/json

request_id

string

required

Unique request ID in the partner system (UUID).

object

required

The object for which the limit is being set.

type

string

required

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

value

string

required

Identifier of the object.

limits

array [object {4}]

required

Array of limit settings.

transaction_type

string

required

Type of transaction the limit applies to.

region

string

optional

Region code(s). Format: ISO alpha-3.

period

string

optional

Limit period. Possible values: transaction, day, month.

amount

array [object {3}]

optional

Array of amount limit objects.

Example

{
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "object": {
    "type": "card",
    "value": "123456789"
  },
  "limits": [
    {
      "transaction_type": "withdrawal_atm",
      "period": "month",
      "amount": [
        {
          "type": "max",
          "value": "5000",
          "currency": "USD"
        }
      ]
    }
  ]
}

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/limits/set' \
--header 'Content-Type: application/json' \
--data-raw '{
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "object": {
    "type": "card",
    "value": "123456789"
  },
  "limits": [
    {
      "transaction_type": "withdrawal_atm",
      "period": "month",
      "amount": [
        {
          "type": "max",
          "value": "5000",
          "currency": "USD"
        }
      ]
    }
  ]
}'

Responses

🟢200Success

application/json

Body

status

string

required

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

request_status

string

required

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

string

required

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

Example

{
    "status": "string",
    "request_status": "string",
    "dt": "2019-08-24T14:15:22Z"
}

Modified at 2025-07-01 05:07:54

Cardholder validation

Limits list