Management v1 - Get all payment methods

Query parameters

Required Optional

pageNumber integer

The number of the page to fetch.

pageSize integer

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

businessLineId string

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

storeId string

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

Path parameters

Required Optional

merchantId string Required

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 more Show less
_links object

Pagination references.

Show children Hide children

first object

The first page.

Show children Hide children

href string

last object

The last page.

Show children Hide children

href string

next object

The next page. Only present if there is a next page.

Show children Hide children

href string

prev object

The previous page. Only present if there is a previous page.

Show children Hide children

href string

self object

The current page.

Show children Hide children

href string

data array [object]

Payment methods details.

Show children Hide children

allowed boolean

Indicates whether receiving payments is allowed. This value is set to true by Adyen after screening your merchant account.

applePay object

Apple Pay details.

Show children Hide children

domains array [string]

The list of merchant domains. Maximum: 99 domains per request.

For more information, see Apple Pay documentation.

bcmc object

Bancontact details.

Show children Hide children

enableBcmcMobile boolean

Indicates if Bancontact mobile is enabled.

businessLineId string

The unique identifier of the business line.

cartesBancaires object

Cartes Bancaires details.

Show children Hide children

siret string

Cartes Bancaires SIRET. Format: 14 digits.

countries array [string]

The list of countries where a payment method is available. By default, all countries supported by the payment method.

currencies array [string]

The list of currencies that a payment method supports. By default, all currencies supported by the payment method.

customRoutingFlags array [string]

The list of custom routing flags to route payment to the intended acquirer.

enabled boolean

Indicates whether the payment method is enabled (true) or disabled (false).

giroPay object

giropay details.

Show children Hide children

supportEmail string

The email address of merchant support.

googlePay object

Google Pay details.

Show children Hide children

merchantId string

Min length: 16 Max length: 20

Google Pay Merchant ID. Character length and limitations: 16 alphanumeric characters or 20 numeric characters.

id string

The identifier of the resource.

klarna object

Klarna details.

Show children Hide children

autoCapture boolean

Indicates the status of Automatic capture. Default value: false.

disputeEmail string

The email address for disputes.

region string

Min length: 2 Max length: 2

The region of operation. For example, NA, EU, CH, AU.

supportEmail string

The email address of merchant support.

mealVoucher_FR object

Meal Voucher FR details.

Show children Hide children

conecsId string

Meal Voucher conecsId. Format: digits only

siret string

Min length: 14 Max length: 14

Meal Voucher siret. Format: 14 digits.

subTypes array [string]

The list of additional payment methods. Allowed values: mealVoucher_FR_endenred, mealVoucher_FR_groupeup, mealVoucher_FR_natixis, mealVoucher_FR_sodexo.

paypal object

PayPal details.

Show children Hide children

directCapture boolean

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.

payerId string

Min length: 13 Max length: 13

PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters.

subject string

Your business email address.

reference string

Max length: 150

Your reference for the payment method. Supported characters a-z, A-Z, 0-9.

shopperInteraction string

The sales channel.

sofort object

Sofort details.

Show children Hide children

currencyCode string

Sofort currency code. For example, EUR.

logo string

Sofort logo. Format: Base64-encoded string.

storeId string

The ID of the store, if any.

swish object

Swish details.

Show children Hide children

swishNumber string

Min length: 10 Max length: 10

Swish number. Format: 10 digits without spaces. For example, 1231111111.

type string

Payment method variant.

verificationStatus string

Payment method status. Possible values:

valid

pending

invalid

rejected

vipps object

Vipps details.

Show children Hide children

logo string

Vipps logo. Format: Base64-encoded string.

subscriptionCancelUrl string

Vipps subscription cancel url

itemsTotal integer

Total number of items.

pagesTotal integer

Total number of pages.

typesWithErrors array [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
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized

Authentication required.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

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
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

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
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

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
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get all payment methods

Endpoint destination URL

Query parameters

Path parameters

Response parameters

HTTP Responses

200 - OK

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error