Get all payment methods

get/merchants/{merchantId}/paymentMethodSettings

Returns details for all payment methods of the merchant account identified in the path.

To make this request, your API credential must have the following role:

Management API—Payment methods read

Endpoint destination URL

https://management-test.adyen.com/v1/merchants/{merchantId}/paymentMethodSettings

Query Parameters

Required

Optional

The number of the page to fetch.

The number of items to have on a page, maximum 100. The default is 10 items on a page.

The unique identifier of the Business Line for which to return the payment methods.

The unique identifier of the store for which to return the payment methods.

Path Parameters

Required

Optional

The unique identifier of the merchant 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
_linksobject
Pagination references.
Show children Hide children
firstobject
The first page.
Show children Hide children
hrefstring
lastobject
The last page.
Show children Hide children
hrefstring
nextobject
The next page. Only present if there is a next page.
Show children Hide children
hrefstring
prevobject
The previous page. Only present if there is a previous page.
Show children Hide children
hrefstring
selfobject
The current page.
Show children Hide children
hrefstring
dataarray[PaymentMethodWrapper]
The list of supported payment methods and their details.
Show children Hide children
PaymentMethodobject
Show children Hide children
afterpayTouchobject
Afterpay Touch details.
Show children Hide children
supportUrlstring
Support Url
allowedboolean
Indicates whether receiving payments is allowed. This value is set to true by Adyen after screening your merchant account.
amexobject
Amex details.
Show children Hide children
midNumberstring
MID (Merchant ID) number. Format: 10 numeric characters. Must be provided only when requesting gatewayContract or paymentDesignatorContract service levels.
reuseMidNumberboolean
Indicates whether the Amex Merchant ID is reused from a previously setup Amex payment method. This is only applicable for gatewayContract and paymentDesignatorContract service levels. The default value is false.
serviceLevelstring
Specifies the service level (settlement type) of this payment method. Possible values:

noContract — Adyen holds the contract with American Express.

gatewayContract — American Express receives the settlement and handles disputes. They then pay out to the merchant directly.

paymentDesignatorContract — Adyen receives the settlement and handles disputes. Adyen then pays out to the merchant.

applePayobject
Apple Pay details.
Show children Hide children
domainsarray[string]
The list of merchant domains. Maximum: 99 domains per request.

For more information, see Apple Pay documentation.
bcmcobject
Bancontact details.
Show children Hide children
enableBcmcMobileboolean
Indicates if Bancontact mobile is enabled.
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

businessLineIdstring
The unique identifier of the business line. Required if you are a platform model.
cartesBancairesobject
Cartes Bancaires details.
Show children Hide children
siretstring
Cartes Bancaires SIRET. Format: 14 digits.
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

clearpayobject
Clearpay details.
Show children Hide children
supportUrlstring
Support Url
countriesarray[string]
The list of countries where a payment method is available. By default, all countries supported by the payment method.
cupobject
China Union Pay details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

currenciesarray[string]
The list of currencies that a payment method supports. By default, all currencies supported by the payment method.
customRoutingFlagsarray[string]
The list of custom routing flags to route payment to the intended acquirer.
dinersobject
Diners details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

discoverobject
Discover details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

eftpos_australiaobject
Eftpos Australia details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

enabledboolean
Indicates whether the payment method is enabled (true) or disabled (false).
giroPayobject
giropay details.
Show children Hide children
supportEmailstring
The email address of merchant support.
girocardobject
Girocard details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

googlePayobject
Google Pay details.
Show children Hide children
merchantIdstring
Min length: 16Max length: 20
Google Pay Merchant ID. Character length and limitations: 16 alphanumeric characters or 20 numeric characters.
reuseMerchantIdboolean
Indicates whether the Google Pay Merchant ID is used for several merchant accounts. Default value: false.
idstring
The identifier of the resource.
idealobject
iDeal details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

interac_cardobject
Interac Card details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

jcbobject
JCB details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

klarnaobject
Klarna details.
Show children Hide children
autoCaptureboolean
Indicates the status of Automatic capture. Default value: false.
disputeEmailstring
The email address for disputes.
regionstring
Min length: 2Max length: 2
The region of operation. For example, NA, EU, CH, AU.
supportEmailstring
The email address of merchant support.
maestroobject
Maestro details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

mcobject
MasterCard details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

mealVoucher_FRobject
Meal Voucher FR details.
Show children Hide children
conecsIdstring
Meal Voucher conecsId. Format: digits only
siretstring
Min length: 14Max length: 14
Meal Voucher siret. Format: 14 digits.
subTypesarray[string]
The list of additional payment methods. Allowed values: mealVoucher_FR_edenred, mealVoucher_FR_groupeup, mealVoucher_FR_natixis, mealVoucher_FR_sodexo.
paypalobject
PayPal details.
Show children Hide children
directCaptureboolean
Indicates if direct (immediate) capture for PayPal is enabled. If set to true, this setting overrides the capture settings of your merchant account. Default value: true.
payerIdstring
Min length: 13Max length: 13
PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters.
subjectstring
Your business email address.
referencestring
Max length: 150
Your reference for the payment method. Supported characters a-z, A-Z, 0-9.
shopperInteractionstring
The sales channel.
sofortobject
Sofort details.
Show children Hide children
currencyCodestring
Sofort currency code. For example, EUR.
logostring
Sofort logo. Format: Base64-encoded string.
storeIdstring
The ID of the store, if any.
swishobject
Swish details.
Show children Hide children
swishNumberstring
Min length: 10Max length: 10
Swish number. Format: 10 digits without spaces. For example, 1231111111.
twintobject
Twint details.
Show children Hide children
logostring
Twint logo. Format: Base64-encoded string.
typestring
Payment method variant.
verificationStatusstring
Payment method status. Possible values:

valid

pending

invalid

rejected

vippsobject
Vipps details.
Show children Hide children
logostring
Vipps logo. Format: Base64-encoded string.
subscriptionCancelUrlstring
Vipps subscription cancel url (required in case of recurring payments)
visaobject
Visa details.
Show children Hide children
transactionDescriptionobject
Information regarding the transaction description.
Show children Hide children
doingBusinessAsNamestring
Max length: 22
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
typestring
The type of transaction description you want to use:

fixed: The transaction description set in this request is used for all payments with this payment method.

append: The transaction description set in this request is used as a base for all payments with this payment method. The transaction description set in the request to process the payment is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.

dynamic: Only the transaction description set in the request to process the payment is used for payments with this payment method.

itemsTotalinteger
Total number of items.
pagesTotalinteger
Total number of pages.
typesWithErrorsarray[string]
Payment method types with errors.
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
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
Show children Hide children
InvalidFieldobject
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
Show more Show less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
Show children Hide children
InvalidFieldobject
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
Show more Show less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
Show children Hide children
InvalidFieldobject
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show more Show less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
Show children Hide children
InvalidFieldobject
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
429
Show more Show less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
Show children Hide children
InvalidFieldobject
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
Show more Show less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[InvalidFieldWrapper]
Detailed explanation of each validation error, when applicable.
Show children Hide children
InvalidFieldobject
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get all payment methods

Query Parameters

Path Parameters

Response parameters

HTTP Responses

200 - OK

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

429

500 - Internal Server Error