\n| transferType<\/a><\/td>\n | Body<\/td>\n | ![\"-white_check_mark-\"](\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" "\\"-white_check_mark-\\"") <\/td>\n | The type of transfer to which the limit applies. Possible values:- instant<\/strong><\/span>: the limit applies to transfers with an instant<\/strong><\/span> priority.<\/li>
- all<\/strong><\/span>: the limit applies to all transfers, regardless of priority.<\/li><\/ul><\/td>\n
| <\/td>\n<\/tr>\n | \n| scaInformation.exemption<\/a><\/td>\n | Body<\/td>\n | <\/td>\n | The type of exemption for Strong Customer Authentication (SCA). Set this to setByPlatform<\/strong><\/span>.<\/td>\n<\/tr>\n\n<\/tr>\n<\/tbody>\n<\/table>\nHere is an example request to create a transfer limit.<\/p>\n \n <\/code-sample>\n<\/div>\n<\/li>\n- \n
Take note of the transferLimitId<\/code> and status<\/code> that is returned in the response. The status<\/code> must be either active<\/strong><\/span> or scheduled<\/strong><\/span> depending on the start date of the limit.<\/p>\n\n <\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\nView transfer limits<\/h2>\nAfter you configure transfer limits for your balance platform, you can make GET requests to view the details of these limits.<\/p>\n View all transfer limits<\/h3>\nTo view all transfer limits configured for your balance platform:<\/p>\n \n- \n
Make a GET \/balancePlatforms\/{id}\/transferLimits<\/a> request. To filter out transfer limits based on their characteristics, include any of the following query parameters in your request:<\/p>\n \n\n\n| Parameter<\/th>\n | Required<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| scope<\/a><\/td>\n | <\/td>\n | The scope on which the transfer limit applies. Possible values:- perTransaction<\/strong><\/span>: you set a maximum amount for each transfer made from the balance platform.<\/li>
- perDay<\/strong><\/span>: you set a maximum total amount for all transfers made from the balance platform in a day.<\/li><\/ul><\/td>\n<\/tr>\n
\n| transferType<\/a><\/td>\n | <\/td>\n | The type of transfer to which the limit applies. Possible values:- instant<\/strong><\/span>: the limit applies to transfers with an instant<\/strong><\/span> priority.<\/li>
- all<\/strong><\/span>: the limit applies to all transfers, regardless of priority.<\/li><\/ul><\/td>\n<\/tr>\n
\n| status<\/a><\/td>\n | <\/td>\n | The status of the transfer limit. Possible values: - active<\/strong><\/span>: the limit is currently active.<\/li>
- inactive<\/strong><\/span>: the limit is currently inactive<\/li>
- scheduled<\/strong><\/span>: the limit is scheduled to become active at a future date.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
For example, you want to view all transfer limits configured on your balance platform that meet the following requirements:<\/p>\n \nscope<\/code>: perDay<\/strong><\/span><\/li>\ntransferType<\/code>: instant<\/strong><\/span><\/li>\nstatus<\/code>: active<\/strong><\/span><\/li>\n<\/ul>\n\n <\/code-sample>\n<\/div>\n<\/li>\n- \n
Take note of the array in the response that returns all the transfer limits on your balance platform that meet the queried requirements.<\/p>\n \n <\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\nView a specific transfer limit<\/h3>\nTo view a specific transfer limit:<\/p>\n \n- \n
Make a GET \/balancePlatforms\/{id}\/transferLimits\/{transferLimitId}<\/a> request. Specify the following parameters in the path:<\/p>\n \n\n\n| Parameter<\/th>\n | Required<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| id<\/a><\/td>\n | <\/td>\n | The unique identifier of your balance platform.<\/td>\n<\/tr>\n | \n| transferLimitId<\/a><\/td>\n | <\/td>\n | The unique identifier of the transfer limit you want to view.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Here is an example request to view a specific transfer limit:<\/p>\n \n <\/code-sample>\n<\/div>\n<\/li>\n- \n
Take note of the response, which returns the details of the transfer limit.<\/p>\n \n <\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\nDelete a transfer limit<\/h2>\nYou can only delete pending<\/strong><\/span> or scheduled<\/strong><\/span> transfer limits. After a transfer limit becomes active<\/strong><\/span>, it cannot be deleted. If you no longer want to apply an active<\/strong><\/span> limit to your balance platform, you must override it by creating a new transfer limit.<\/p>\nTo delete a pending<\/strong><\/span> or scheduled<\/strong><\/span> transfer limit, make a DELETE \/balancePlatforms\/{id}\/transferLimits\/{transferLimitId}<\/a> request. Specify the following parameters in the path:<\/p>\n\n\n\n| Parameter<\/th>\n | Required<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| id<\/a><\/td>\n | <\/td>\n | The unique identifier of your balance platform.<\/td>\n<\/tr>\n | \n| transferLimitId<\/a><\/td>\n | <\/td>\n | The unique identifier of the transfer limit you want to delete.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Here is an example request to delete a specific transfer limit:<\/p>\n \n <\/code-sample>\n<\/div>\nIf the transfer limit is successfully deleted, you receive a HTTP 204 - No Content<\/code> response.<\/p>","url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/use-transfer-limits\/balance-platform","articleFields":{"description":"Set a limit on outgoing transfers from your balance platform.","feedback_component":true,"parameters":{"directoryPath":"\/business-accounts","model":"balance platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/use-transfer-limits\/balance-platform","title":"Create and manage transfer limits for your balance platform","content":"Transfer limits create conditional logic that automatically approves or declines a transfer based on its amount. When a transfer limit is configured for your balance platform, it regulates the amount of funds that can be transferred externally from all the balance accounts in your platform.\nRequirements\nBefore you begin, make sure that you complete the following requirements:\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nAdyen for Platforms integration with business accounts.\n\n\nAPI credential roles\nMake sure that you have access to the Configuration API with the following role:Balance platform base role\n\n\nWebhooks\nSubscribe to the following webhook(s): \n Transfer webhooks\n\n Transaction webhooks\n\n\n\nLimitations\nTransfer limits are not supported for internal transfers, or incoming external transfers.\n\n\nSetup steps\nBefore you begin: Make sure you are familiar with how transfer limits work.\n\n\n\nHow it works\n\nYou create a transfer limit by making a POST \/balancePlatforms\/{id}\/transferLimits request. In your request, you must consider the scope and type of the transfer, and specify the time period in which the transfer limit is valid.\nThe transfer limit is created with a scheduled status.\nOn the start date of the transfer limit, the status of the transfer limit becomes active.\nWhile it is active, the transfer limit regulates the amount of funds being transferred externally from the balance account.\nWhen the end date of the transfer limit passes, it reaches an inactive state.\n\nCreate transfer limits\nTo create a new transfer limit:\n\n\nMake a POST \/balancePlatforms\/{id}\/transferLimits request. Include the following parameters:\n\n\n\nParameter\nType\nRequired\nDescription\n\n\n\n\n id\nPath\n\nThe unique identifier of your balance platform.\n\n\n amount.value\nBody\n\nThe value, in minor units, for the transfer limit. This is the maximum amount allowed per transfer or per day based on the scope of the limit.\n\n\n\n amount.currency\nBody\n\nThe currency in which you want to set the limit.\n\n\n\n startsAt\nBody\n\nThe date, in ISO date and time format, when the transfer limit becomes active.Format: YYYY-MM-DDThh:mm:ss.sssTZDIf you do not specify a start date, or set this to null, we default to the date and time of the request.If you specify a date in the future, we will schedule a transfer limit. You cannot schedule more than one limit in the future.\n\n\n\n endsAt\nBody\n\nThe date and time, in ISO date and time format, when the transfer limit becomes inactive.Format: YYYY-MM-DDThh:mm:ss.sssTZDIf you do not specify an end date, the limit stays active until you override it with a new limit.\n\n\n\n scope\nBody\n\nThe scope on which the transfer limit applies. Possible values:perTransaction: you set a maximum amount for each transfer made from the balance platform.perDay: you set a maximum total amount for all transfers made from the balance platform in a day.\n\n\n\n reference\nBody\n\nYour reference for the transfer limit.\n\n\n\n transferType\nBody\n\nThe 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.\n\n\n\n scaInformation.exemption\nBody\n\nThe type of exemption for Strong Customer Authentication (SCA). Set this to setByPlatform.\n\n\n\n\n\nHere is an example request to create a transfer limit.\n\n\n\n\n\nTake note of the transferLimitId and status that is returned in the response. The status must be either active or scheduled depending on the start date of the limit.\n\n\n\n\n\nView transfer limits\nAfter you configure transfer limits for your balance platform, you can make GET requests to view the details of these limits.\nView all transfer limits\nTo view all transfer limits configured for your balance platform:\n\n\nMake a GET \/balancePlatforms\/{id}\/transferLimits request. To filter out transfer limits based on their characteristics, include any of the following query parameters in your request:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n scope\n\nThe scope on which the transfer limit applies. Possible values:perTransaction: you set a maximum amount for each transfer made from the balance platform.perDay: you set a maximum total amount for all transfers made from the balance platform in a day.\n\n\n transferType\n\nThe 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.\n\n\n status\n\nThe status of the transfer limit. Possible values: active: the limit is currently active.inactive: the limit is currently inactivescheduled: the limit is scheduled to become active at a future date.\n\n\n\nFor example, you want to view all transfer limits configured on your balance platform that meet the following requirements:\n\nscope: perDay\ntransferType: instant\nstatus: active\n\n\n\n\n\n\nTake note of the array in the response that returns all the transfer limits on your balance platform that meet the queried requirements.\n\n\n\n\n\nView a specific transfer limit\nTo view a specific transfer limit:\n\n\nMake a GET \/balancePlatforms\/{id}\/transferLimits\/{transferLimitId} request. Specify the following parameters in the path:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n id\n\nThe unique identifier of your balance platform.\n\n\n transferLimitId\n\nThe unique identifier of the transfer limit you want to view.\n\n\n\nHere is an example request to view a specific transfer limit:\n\n\n\n\n\nTake note of the response, which returns the details of the transfer limit.\n\n\n\n\n\nDelete a transfer limit\nYou can only delete pending or scheduled transfer limits. After a transfer limit becomes active, it cannot be deleted. If you no longer want to apply an active limit to your balance platform, you must override it by creating a new transfer limit.\nTo delete a pending or scheduled transfer limit, make a DELETE \/balancePlatforms\/{id}\/transferLimits\/{transferLimitId} request. Specify the following parameters in the path:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n id\n\nThe unique identifier of your balance platform.\n\n\n transferLimitId\n\nThe unique identifier of the transfer limit you want to delete.\n\n\n\nHere is an example request to delete a specific transfer limit:\n\n \n\nIf the transfer limit is successfully deleted, you receive a HTTP 204 - No Content response.","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Business accounts","lvl2":"Use transfer limits","lvl3":"Create and manage transfer limits for your balance platform"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/business-accounts","lvl2":"https:\/\/docs.adyen.com\/pt\/business-accounts\/use-transfer-limits","lvl3":"\/pt\/business-accounts\/use-transfer-limits\/balance-platform"},"levels":4,"category":"","category_color":"","tags":["Create","manage","transfer","limits","balance","platform"]}}
| |
|
|
| |
|