APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementPayout settings merchant level

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

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

merchantId*string

The unique identifier of the merchant account.

payoutSettingsId*string

The unique identifier of the payout setting.

Request Body

application/json

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 Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/merchants/string/payoutSettings/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "allowed": true,  "enabled": true,  "enabledFromDate": "string",  "id": "string",  "priority": "first",  "transferInstrumentId": "string",  "verificationStatus": "invalid"}

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

Delete a payout setting DELETE

Deletes 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 and write