Create a transfer limit

post/balancePlatforms/{id}/transferLimits

API Version

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

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v2/balancePlatforms/{id}/transferLimits

Path Parameters

Required

Optional

The unique identifier of the balance platform.

Request Parameters

Required

Optional

The amount for the transfer limit. This is the maximum amount allowed per transfer or per day based on the scope of the limit.

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

Your reference for the transfer limit.

Information for the Strong Customer Authentication (SCA)

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

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 parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
amountobject
The amount for the transfer limit. This is the maximum amount allowed per transfer or per day based on the scope of the limit.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
endsAtstring
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
The unique identifier of the transfer limit.
limitStatusstring
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.
scaInformationobject
Information for the Strong Customer Authentication (SCA)
exemptionstring
The type of exemption for Strong Customer Authentication (SCA). Possible values:

lowerLimit: the newly created limit is lower than the existing limit.

notRegulated: the limit is created in a country, region, or industry where it is not mandated by law to use SCA.

setByPlatform: you set a limit for one of your user's balance accounts, or for your balance platform.

initialLimit: there are no existing transfer limits set on the balance account or balance platform.

alreadyPerformed: you are confident about your user's identity and do not need to verify this using SCA.

statusstring
The status of Strong Customer Authentication (SCA). Possible values:

notPerformed: the requester was unable to successfully authenticate the request using SCA, or has an SCA exemption.

pending: the request is pending SCA authentication.

performed: the request is successfully authenticated using SCA.

scopestring
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
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
transferTypestring
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.
404 - Not found
One of the transfer limits could not be found.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Content
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Create a transfer limit

HTTP Responses

200 - OK

404 - Not found

422 - Unprocessable Content