v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-3196247792.5 KB
Transfer limits - balance account level

Filter and view the transfer limits

Filter and view the transfer limits configured for a balance account using the balance account's unique id and the available query parameters.

get/balanceAccounts/{id}/transferLimits

Path parameters

idstring required

The unique identifier of the balance account.

Query parameters

scope'perDay' | 'perTransaction'

The scope to which the transfer limit applies. Possible values:

  • perTransaction: you set a maximum amount for each transfer made from the balance account or balance platform.
  • perDay: you set a maximum total amount for all transfers made from the balance account or balance platform in a day.

The scope to which the transfer limit applies. Possible values:

  • perTransaction: you set a maximum amount for each transfer made from the balance account or balance platform.
  • perDay: you set a maximum total amount for all transfers made from the balance account or balance platform in a day.
transferType'instant' | 'all'

The type of transfer to which the limit applies. Possible values:

  • instant: the limit applies to transfers with an instant priority.
  • all: the limit applies to all transfers, regardless of priority.

The type of transfer to which the limit applies. Possible values:

  • instant: the limit applies to transfers with an instant priority.
  • all: the limit applies to all transfers, regardless of priority.
status'active' | 'inactive' | 'pendingSCA' | 'scheduled'

The status of the transfer limit. Possible values:

  • active: the limit is currently active.
  • inactive: the limit is currently inactive.
  • pendingSCA: the limit is pending until your user performs SCA.
  • scheduled: the limit is scheduled to become active at a future date.

The status of the transfer limit. Possible values:

  • active: the limit is currently active.
  • inactive: the limit is currently inactive.
  • pendingSCA: the limit is pending until your user performs SCA.
  • scheduled: the limit is scheduled to become active at a future date.

Response

OK - The request has succeeded.