Request a payment method
Sends a request to add a new payment method to the merchant account identified in the path.
Depending the payment method type, you may need to send an additional object required for the payment method.
To make this request, your API credential must have the following role:
- Management API—Payment methods read and write
The unique identifier of the merchant account.
Details to provide if type is accel.
The type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is affirm.
Selected Affirm financing package. Choose from core, standard, or signature. Defaults to core if no selection made.
Merchant support email used to manage disputes.
Details to provide if type is afterpaytouch.
Support Email
Support Url
Details to provide if type is alipay_plus.
The currency used for settlement. Defaults to USD.
Details to provide if type is amex.
For merchants operating in Australia, New Zealand & Canada, JCB and American Express are automatically requested together.
Merchant ID (MID) number. Format: 10 numeric characters.
You must provide this field when you request gatewayContract or paymentDesignatorContract service levels.
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.
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, then pays out to you or your sub-merchant directly.
- paymentDesignatorContract: Adyen receives the settlement, and handles disputes and payouts.
Details to provide if type is applepay.
The list of merchant domains. Maximum: 99 domains per request.
For more information, see Apple Pay documentation.
Details to provide if type is bcmc (Bancontact).
Indicates if Bancontact mobile is enabled.
The unique identifier of the business line. Required if you are a platform model.
Details to provide if type is carnet.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is cartebancaire.
Cartes Bancaires SIRET. Format: 14 digits.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is clearpay.
Support Url
The list of countries where a payment method is available. By default, all countries supported by the payment method.
Details to provide if type is cup (China Union Pay).
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
The list of currencies that a payment method supports. By default, all currencies supported by the payment method.
The list of custom routing flags to route payment to the intended acquirer.
Details to provide if type is diners.
For merchants operating in Japan, Diners payments are processed through the JCB network. This means that you must include JCB-specific fields in this object.
MID (Merchant ID) number. Required for merchants operating in Japan. Format: 14 numeric characters.
Indicates whether the JCB Merchant ID is reused from a previously configured JCB payment method. The default value is false. For merchants operating in Japan, this field is required and must be set to true.
Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan. Possible values:
- noContract: Adyen holds the contract with JCB.
- gatewayContract: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is discover.
For merchants operating in Japan, request Diners payment method instead. Discover is automatically requested, together with Diners.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is eft_directdebit_CA (EFT PAD).
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is eftpos_australia.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is girocard.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is givex.
The three-character ISO currency code, such as EUR.
The password provided by the acquirer.
The sales channel used for the payment.
The username provided by the acquirer.
Details to provide if type is googlepay.
Google Pay Merchant ID. Character length and limitations: 16 alphanumeric characters or 20 numeric characters.
Indicates whether the Google Pay Merchant ID is used for several merchant accounts. Default value: false.
Details to provide if type is ideal.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is interac_card.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is jcb.
For merchants operating in Japan, midNumber, reuseMidNumber, and serviceLevel fields are required.
For merchants operating outside of Japan, these fields are not required.
For merchants operating in Australia, New Zealand & Canada, JCB and American Express are automatically requested together.
MID (Merchant ID) number. Required for merchants operating in Japan or merchants operating in Canada, Australia and New Zealand when requesting gatewayContract or paymentDesignatorContract service levels.Format: 14 numeric characters for Japan, 10 numeric characters for Canada, Australia and New Zealand.
Indicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. The default value is false.For merchants operating in Japan, this field is required and must be set to true.
Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan. Possible values:
- noContract: Adyen holds the contract with JCB for merchants operating in Japan or American Express for merchants operating in Canada, Australia and New Zealand.
- gatewayContract: JCB or American Express receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
- paymentDesignatorContract: Available only for merchants operating in Canada, Australia and New Zealand. Adyen receives the settlement, and handles disputes and payouts.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is klarna or its variant.
You can use the following payment method type values for Klarna:
- klarna: Klarna Pay Later
- klarna_account: Klarna Pay over time
- klarna_paynow: Klarna Pay now
- klarna_b2b: Billie via Klarna
Indicates the status of Automatic capture. Default value: false.
The email address for disputes.
The region of operation. For example, NA, EU, CH, AU.
The email address of merchant support.
Details to provide if type is maestro.
In the US, maestro is not supported; use maestro_usa instead.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is maestro_usa.
Only for Maestro USA, otherwise use maestro.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is mc.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is mealVoucher_FR.
Meal Voucher conecsId. Format: digits only
Meal Voucher siret. Format: 14 digits.
The list of additional payment methods. Allowed values: mealVoucher_FR_edenred, mealVoucher_FR_groupeup, mealVoucher_FR_natixis, mealVoucher_FR_sodexo.
Details to provide if type is nyce.
The type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is paybybank_plaid.
Merchant logo (max. size 150kB). Format: Base64-encoded string.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is payme.
Merchant display name
Merchant logo. Format: Base64-encoded string.
The email address of merchant support.
Details to provide if type is paypal.
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.
PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters.
Your business email address.
Details to provide if type is payto.
Merchant name displayed to the shopper in the Agreements
Represents the purpose of the Agreements created, it relates to the business type Allowed values: mortgage, utility, loan, gambling, retail, salary, personal, government, pension, tax, other
Details to provide if type is pulse.
The type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Your reference for the payment method. Supported characters a-z, A-Z, 0-9.
Details to provide if type is sepadirectdebit.
Creditor id
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
The sales channel. Required if:
- The merchant account does not have a sales channel.
typeis alipay.
When you provide this field, it overrides the default sales channel set on the merchant account.
Possible values: eCommerce, pos, contAuth, and moto.
Details to provide if type is sodexo.
Sodexo merchantContactPhone
Sofort details.
Sofort currency code. For example, EUR.
Sofort logo. Format: Base64-encoded string.
Details to provide if type is star.
The type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
The unique identifier of the store for which to configure the payment method, if any.
Details to provide if type is svs.
The merchant ID (MID) that the acquirer recognizes you by.
The three-character ISO currency code, example USD
Details to provide if type is swish.
- This field is required only if you have a contract with Swish. Swish handles settlement directly with you (not through Adyen).
- If not specified then it's assumed that you are using Adyen's contract with Swish.You don't have a direct relationship with Swish.
Swish number. Format: 10 digits without spaces. For example, 1231111111.
Details to provide if type is ticket (Edenred Brazil).
Ticket requestorId
Details to provide if type is twint.
Twint logo. Format: Base64-encoded string.
Payment method variant.
Details to provide if type is valuelink.
Authorisation Mid
PIN Support. For ecommerce, PIN is required.
Submitter ID
Terminal ID
Details to provide if type is vipps.
Vipps logo. Format: Base64-encoded string.
Vipps subscription cancel url (required in case of recurring payments)
Details to provide if type is visa.
Information regarding the transaction description.
You cannot configure the transaction description in the test environment.
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 . , ' _ - ? + * /.
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.
Details to provide if type is wechatpay.
The name of the contact person from merchant support.
The email address of merchant support.
Details to provide if type is wechatpay_pos.
The name of the contact person from merchant support.
The email address of merchant support.
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.
accelobjectaccel details
processingTypestringThe type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
affirmobjectaffirm* details
publicApiKeystringAffirm public API key
afterpayTouchobjectafterpaytouch details
supportEmailstringSupport Email
supportUrlstringSupport Url
alipayPlusobjectalipay_plus details
settlementCurrencyCodestringThe currency used for settlement.
allowedbooleanIndicates whether receiving payments is allowed. This value is set to true by Adyen after screening your merchant account.
amexobjectamex details
midNumberstringMerchant ID (MID) number.
reuseMidNumberbooleanIndicates whether the Amex Merchant ID is reused from a previously setup Amex payment method.
serviceLevelstringThe 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, then pays out to you or your sub-merchant directly.
- paymentDesignatorContract: Adyen receives the settlement, and handles disputes and payouts.
applePayobjectapplepay details
domainsarray[string]The list of merchant domains.
For more information, see Apple Pay documentation.
bcmcobjectbcmc (Bancontact) details
enableBcmcMobilebooleanIndicates if Bancontact mobile is enabled.
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
businessLineIdstringThe unique identifier of the business line. Required if you are a platform model.
carnetobjectcarnet details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
cartesBancairesobjectcartesbancaire details
siretstringCartes Bancaires SIRET. Format: 14 digits.
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
clearpayobjectclearpay details
supportUrlstringSupport Url
countriesarray[string]The list of countries where a payment method is available. By default, all countries supported by the payment method.
cupobjectcup (China Union Pay) details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
dinersobjectdiners details
midNumberstringMID (Merchant ID) number.
reuseMidNumberbooleanIndicates whether the JCB Merchant ID is reused from a previously configured JCB payment method.
serviceLevelstringThe service level (settlement type) of this payment method. Possible values:
- noContract: Adyen holds the contract with JCB.
- gatewayContract: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
discoverobjectdiscover. details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
eft_directdebit_CAobjecteft_directdebit_CA (EFT PAD) details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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_australiaobjecteftpos_australia details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
enabledbooleanIndicates whether the payment method is enabled (true) or disabled (false).
girocardobjectgirocard details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
givexobjectgivex details
currencyCodestringThe three-character ISO currency code
passwordstringThe password provided by the acquirer.
paymentFlowstringThe sales channel used for the payment.
usernamestringThe username provided by the acquirer.
googlePayobjectgooglepay details
merchantIdstringGoogle Pay [Merchant ID]
reuseMerchantIdbooleanIndicates whether the Google Pay Merchant ID is used for several merchant accounts.
idstringThe identifier of the resource.
idealobjectideal details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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_cardobjectinterac_card details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
jcbobjectjcb details
midNumberstringMID (Merchant ID) number.
reuseMidNumberbooleanIndicates whether the JCB Merchant ID is reused from a previously setup JCB payment method.
serviceLevelstringSpecifies the service level (settlement type) of this payment method.
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
klarnaobjectklarna or its variant details
autoCapturebooleanIndicates the status of Automatic capture.
disputeEmailstringThe email address for disputes.
regionstringThe region of operation.
supportEmailstringThe email address of merchant support.
maestroobjectmaestro details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
maestro_usaobjectDetails to provide if
typeis maestro_usa detailstransactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
mcobjectmc details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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_FRobjectmealVoucher_FR details
conecsIdstringMeal Voucher conecsId.
siretstringMeal Voucher siret.
subTypesarray[string]The list of additional payment methods.
nyceobjectnyce details
processingTypestringThe type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
paybybank_plaidobjectpaybybank_plaid details
logostringDeprecatedMerchant logo
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
paymeobjectpayme details
displayNamestringMerchant display name
logostringMerchant logo. Format: Base64-encoded string.
supportEmailstringThe email address of merchant support.
paypalobjectpaypal details
directCapturebooleanIndicates 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.
payerIdstringMin length: 13Max length: 13PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters.
subjectstringYour business email address.
paytoobjectpayto details
merchantNamestringMerchant name displayed to the shopper in the Agreements
payToPurposestringRepresents the purpose of the Agreements created, it relates to the business type Allowed values: mortgage, utility, loan, gambling, retail, salary, personal, government, pension, tax, other
pulseobjectpulse details
processingTypestringThe type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
referencestringMax length: 150Your reference for the payment method. Supported characters a-z, A-Z, 0-9.
sepadirectdebitobjectsepadirectdebit details
creditorIdstringCreditor id
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
shopperInteractionstringThe sales channel.
sodexoobjectsodexo details
merchantContactPhonestringSodexo merchantContactPhone
sofortobjectDeprecated in version 1Sofort details.
currencyCodestringSofort currency code. For example, EUR.
logostringSofort logo. Format: Base64-encoded string.
starobjectstar details
processingTypestringThe type of transactions processed over this payment method. Allowed values:
- pos for in-person payments.
- billpay for subscription payments, both the initial payment and the later recurring payments. These transactions have
recurringProcessingModelSubscription. - ecom for all other card not present transactions. This includes non-recurring transactions and transactions with
recurringProcessingModelCardOnFile or UnscheduledCardOnFile.
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
storeIdsarray[string]The unique identifier of the store for which to configure the payment method, if any.
svsobjectsvs details
authorisationMidstringThe merchant ID (MID) that the acquirer recognizes you by.
currencyCodestringThe three-character ISO currency code, example USD
swishobjectswish or its variant details
swishNumberstringMin length: 10Max length: 10Swish number. Format: 10 digits without spaces. For example, 1231111111.
ticketobjectticket (Edenred Brazil) details
requestorIdstringTicket requestorId
twintobjecttwint details
logostringTwint logo. Format: Base64-encoded string.
typestringPayment method variant.
valuelinkobjectvaluelink details
authorisationMidstringAuthorisation Mid
pinSupportstringPIN Support. For ecommerce, PIN is required.
submitterIdstringSubmitter ID
terminalIdstringTerminal ID
verificationStatusstringPayment method status. Possible values:
- valid
- pending
- invalid
- rejected
vippsobjectvipps details
logostringVipps logo. Format: Base64-encoded string.
subscriptionCancelUrlstringVipps subscription cancel url (required in case of recurring payments)
visaobjectvisa details
transactionDescriptionobjectInformation regarding the transaction description.
doingBusinessAsNamestringMax length: 22The 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 . , ' _ - ? + * /.
typestringThe 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.
wechatpayobjectwechatpay details
contactPersonNamestringThe name of the contact person from merchant support.
emailstringThe email address of merchant support.
wechatpay_posobjectwechatpay_pos details
contactPersonNamestringThe name of the contact person from merchant support.
emailstringThe email address of merchant support.
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.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
429
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA 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.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.