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
Endpoint destination URL{merchantId}/payoutSettings
Click to copy

Path Parameters


The unique identifier of the merchant account.

Request Parameters


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.

    Show moreShow less
  • 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.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less