Add a payout setting
Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the transfer instrument that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting.
If you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account.
Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.
To make this request, your API credential must have the following roles:
- Management API—Payout account settings read and write
In: header
Path Parameters
The unique identifier of the merchant account.
Request Body
application/json
Indicates if payouts to this bank account are enabled. Default: true.
To receive payouts into this bank account, both enabled and allowed must be true.
The date when Adyen starts paying out to this bank account.
Format: ISO 8601, for example, 2019-11-23T12:25:28Z or 2020-05-27T20:25:28+08:00.
If not specified, the enabled field indicates if payouts are enabled for this bank account.
If a date is specified and:
enabled: true, payouts are enabled starting the specified date.enabled: false, payouts are disabled until the specified date. On the specified date,enabledchanges to true and this field is reset to null.
The unique identifier of the transfer instrument that contains the details of the bank account.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/merchants/string/payoutSettings" \ -H "Content-Type: application/json" \ -d '{ "transferInstrumentId": "string" }'{ "allowed": true, "enabled": true, "enabledFromDate": "string", "id": "string", "priority": "first", "transferInstrumentId": "string", "verificationStatus": "invalid"}Get a list of payout settings GET
Returns the list of payout settings for the merchant account identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read
Get a payout setting GET
Returns the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read