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

Get a payout setting

GET
/merchants/{merchantId}/payoutSettings/{payoutSettingsId}

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:

  • Management API—Payout account settings read

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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/merchants/string/payoutSettings/string"
{  "allowed": true,  "enabled": true,  "enabledFromDate": "string",  "id": "string",  "priority": "first",  "transferInstrumentId": "string",  "verificationStatus": "invalid"}

Add a payout setting POST

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](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) 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](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write

Update a payout setting PATCH

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](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write