POST /merchants/{merchantId}/payoutSettings
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
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
merchantId |
String | Yes |
The unique identifier of the merchant account. |
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 |
|---|---|---|---|
transferInstrumentId |
String | Yes |
The unique identifier of the transfer instrument that contains the details of the bank account. |
enabled |
Boolean | No |
Indicates if payouts to this bank account are enabled. Default: true. To receive payouts into this bank account, both |
enabledFromDate |
String | No |
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 If a date is specified and:
|
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.