Update a payout setting

patch /merchants/{merchantId}/payoutSettings/{payoutSettingsId}

Updates the payout setting identified in the path. You can enable or disable the payout setting.

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

Click to copy

Path parameters

payoutSettingsId string Required

The unique identifier of the payout setting.

merchantId string Required

The unique identifier of the merchant account.

Request parameters

enabled boolean

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.

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 more Show 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 more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less