Sign in
Transfer limits - balance platform level

Create a transfer limit

Create a transfer limit for your balance platform using the unique id of your balance platform.

post/balancePlatforms/{id}/transferLimits

Path parameters

idstring required

The unique identifier of the balance platform.

Request body

endsAtstring date-time

The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit.

Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD

referencestring

Your reference for the transfer limit.

scope'perDay' | 'perTransaction' required

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.
startsAtstring date-time

The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit.

Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD

transferType'instant' | 'all' required

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.

Response

OK - The request has succeeded.

endsAtstring date-time

The date and time when the transfer limit becomes inactive. If you do not specify an end date, the limit stays active until you override it with a new limit.

Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD

idstring required

The unique identifier of the transfer limit.

limitStatus'active' | 'inactive' | 'pendingSCA' | 'scheduled' required

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.
referencestring

Your reference for the transfer limit.

scope'perDay' | 'perTransaction' required

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.
startsAtstring date-time required

The date and time when the transfer limit becomes active. If you specify a date in the future, we will schedule a transfer limit.

Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD

transferType'instant' | 'all' required

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.

Changes

Changed in 1 of the 51 revisions of this API.1