Skip to main content
GET
/
v1
/
transactions
/
limits
/
available
Retrieve available transaction limits
curl --request GET \
  --url http://localhost:4011/v1/transactions/limits/available \
  --header 'Authorization: Bearer <token>'
{
  "limits": [
    {
      "limitType": "PERIOD",
      "periodType": "DAILY",
      "totalLimit": 30000,
      "usedAmount": 5000,
      "availableAmount": 25000
    },
    {
      "limitType": "TRANSACTION",
      "periodType": "DAILY",
      "totalLimit": 10000,
      "usedAmount": 0,
      "availableAmount": 10000
    },
    {
      "limitType": "PERIOD",
      "periodType": "NIGHTLY",
      "totalLimit": 30000,
      "usedAmount": 1500,
      "availableAmount": 28500
    },
    {
      "limitType": "TRANSACTION",
      "periodType": "NIGHTLY",
      "totalLimit": 10000,
      "usedAmount": 0,
      "availableAmount": 10000
    }
  ],
  "currentPeriod": "DAILY"
}

Authorizations

Authorization
string
header
required

JWT token obtained from the authentication endpoint

Query Parameters

account_id
string<uuid>
required

Account ID to get available limits for

Response

Available transaction limits retrieved successfully

limits
object[]
required

Array of available limit objects with usage information

currentPeriod
enum<string>
required

Current active period based on time of day

Available options:
DAILY,
NIGHTLY,
MONTHLY
Example:

"DAILY"

I