ADadyen
Payout settings - merchant level

Get a payout setting

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
get/merchants/{merchantId}/payoutSettings/{payoutSettingsId}

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/merchants/{merchantId}/payoutSettings/{payoutSettingsId}
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

payoutSettingsIdstring required

The unique identifier of the payout setting.

Response

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 required

The unique identifier of the payout setting.

priority'first' | 'normal' | 'urgent'

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 required

The unique identifier of the transfer instrument that contains the details of the bank account.

verificationStatus'invalid' | 'pending' | 'rejected' | 'valid'

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.

Changes

No recorded changes to this operation across all 50 revisions of this API.