Add a payout setting

post/merchants/{merchantId}/payoutSettings

API Version

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

Endpoint destination URL

https://management-test.adyen.com/v3/merchants/{merchantId}/payoutSettings

Path Parameters

Required

Optional

The unique identifier of the merchant account.

Request Parameters

Required

Optional

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, enabled changes 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 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.
allowedboolean
Indicates if payouts to the bank account are allowed. This value is set automatically based on the status of the verification process. The value is:

true if verificationStatus is valid.

false for all other values.

enabledboolean
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.
enabledFromDatestring
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, enabled changes to true and this field is reset to null.

idstring
The unique identifier of the payout setting.
prioritystring
Determines how long it takes for the funds to reach the bank account. Adyen pays out based on the payout frequency. Depending on the currencies and banks involved in transferring the money, it may take up to three days for the payout funds to arrive in the bank account.

Possible values:

first: same day.

urgent: the next day.

normal: between 1 and 3 days.

transferInstrumentIdstring
The unique identifier of the transfer instrument that contains the details of the bank account.
verificationStatusstring
The status of the verification process for the bank account.

Possible values:

valid: the verification was successful.

pending: the verification is in progress.

invalid: the information provided is not complete.

rejected: there are reasons to refuse working with this entity.
204 - No Content
The request has been successfully processed, but there is no additional content.
400 - Bad Request
A problem reading or understanding the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Add a payout setting

HTTP Responses

200 - OK

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error