For the complete documentation index, see llms.txt. This page is also available as Markdown.

List Limits

Retrieves a paginated list of transaction limits with comprehensive filtering options. Limits define minimum and maximum amounts for various operation types and payment methods.

Endpoint

GET/v2/billing/limits

Link

Request

Query Parameters

Parameter
Type
Description & Values
Required
Example

currencyIsoFrom

string

Filter by source currency (ISO 4217).

No

"USD"

currencyIsoTo

string

Filter by target currency (ISO 4217).

No

"EUR"

customerId

string

Filter by specific customer.

No

"cust_12345"

fromCreatedAt

string

Filter limits created after this date (ISO 8601).

No

"2024-01-01T00:00:00Z"

fromUpdatedAt

string

Filter limits updated after this date (ISO 8601).

No

"2024-05-01T00:00:00Z"

meta.page

integer

Page number (starts from 0).

No

0

meta.pageSize

integer

Items per page.

No

20

operationType

string

Filter by operation type: - NOTSET: Service type - DEPOSIT - TRANSFER - WITHDRAW - COMMISSION - EXCHANGE - CORRECTING

No

"TRANSFER"

paymentType

string

Filter by payment method: - EMPTY: Service type - ACH - FEDWIRE - SWIFT - CRYPTO - EFT - SEPA_CT - IMPS

No

"SWIFT"

toCreatedAt

string

Filter limits created before this date (ISO 8601).

No

"2024-12-31T23:59:59Z"

toUpdatedAt

string

Filter limits updated before this date (ISO 8601).

No

"2024-05-21T23:59:59Z"

withAllCustomers

boolean

Include system-wide limits (true) or customer-specific only (false).

No

true

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Accept

application/json

Yes


Response (200 OK)

Returns a paginated list of limit configurations.

Response Fields

1. Meta Object

Field
Type
Description
Example

pageSize

integer

Items per page.

20

page

integer

Current page number.

0

total

string

Total limits available.

"150"

2. Limit Object (items[])

Field
Type
Description
Example

id

integer

Unique limit identifier.

101

owner

integer

Owner ID (system or customer).

15

currencyIsoFrom

string

Source currency (ISO 4217).

"USD"

currencyIsoTo

string

Target currency (ISO 4217).

"EUR"

operationType

string

Operation type (see values above).

"TRANSFER"

paymentType

string

Payment method (see values above).

"SWIFT"

min

number

Minimum amount allowed.

10.0

max

number

Maximum amount allowed.

10000.0

createdAt

string

Creation timestamp (ISO 8601).

"2024-01-15T10:30:00Z"

updatedAt

string

Last update timestamp (ISO 8601).

"2024-05-20T14:45:00Z"

customerName

string

Customer name (if customer-specific).

"John Doe"

customerId

string

Customer ID (if customer-specific).

"cust_12345"

Example Response:


Examples

Request

Request for Crypto Limits


Error Responses

  1. Invalid Currency:

  2. Invalid Operation Type:


Notes

  • System vs Customer Limits:

    • owner=0 indicates system-wide limits

    • owner>0 indicates customer-specific limits

  • Currency Pairs: For single-currency operations, currencyIsoFrom and currencyIsoTo are the same.

  • Empty Customer Fields: System limits have empty customerName and customerId.

  • Limit Hierarchy: Customer-specific limits override system limits when both exist.

Request sample

Response sample

Last updated