POST /balancePlatforms/{id}/transferLimits

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

Servers

https://balanceplatform-api-test.adyen.com/bcl/v2

Path parameters

Name	Type	Required	Description
`id`	String	Yes	The unique identifier of the balance platform.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`startsAt`	String	No	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
`endsAt`	String	No	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
`transferType`	String	Yes	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. Valid values: `"instant"` `"all"`
`amount`	Object	Yes	The amount for the transfer limit. This is the maximum amount allowed per transfer or per day based on the `scope` of the limit.
`amount.value`	Integer	Yes	The amount of the transaction, in minor units.
`amount.currency`	String	Yes	The three-character ISO currency code.
`scope`	String	Yes	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. Valid values: `"perDay"` `"perTransaction"`
`reference`	String	No	Your reference for the transfer limit.
`scaInformation`	Object	No	Information for the Strong Customer Authentication (SCA)
`scaInformation.scaOnApproval`	Boolean	No	Indicates whether to initiate Strong Customer Authentication (SCA) later, during approval, or immediately after you submit this request. Possible values: true: you can initiate SCA later, during approval, for all pending transfer limits. false (default): you initiate SCA immediately after submitting the transfer limit request.
`scaInformation.exemption`	String	No	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. Valid values: `"initialLimit"` `"lowerLimit"` `"setByPlatform"` `"notRegulated"` `"alreadyPerformed"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.