Request a payment method

HTTP Responses

• 200 - OK

  The request has succeeded.

  Show moreShow less

  accelobject

  ACCEL details.

  Show childrenHide children

  processingTypestring

  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 recurringProcessingModel Subscription.
  • ecom for all other card not present transactions. This includes non-recurring transactions and transactions with recurringProcessingModel CardOnFile or UnscheduledCardOnFile.

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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.

  afterpayTouchobject

  Afterpay Touch details.

  Show childrenHide 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 childrenHide children

  midNumberstring

  Max length: 10

  Merchant ID (MID) number. Format: 10 numeric characters. You must provide this field when you request 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, then pays out to you or your sub-merchant directly.
  • paymentDesignatorContract: Adyen receives the settlement, and handles disputes and payouts.

  applePayobject

  Apple Pay details.

  Show childrenHide children

  domainsarray[string]

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

  For more information, see Apple Pay documentation.

  bcmcobject

  Bancontact details.

  Show childrenHide children

  enableBcmcMobileboolean

  Indicates if Bancontact mobile is enabled.

  businessLineIdstring

  The unique identifier of the business line. Required if you are a platform model.

  cartesBancairesobject

  Cartes Bancaires details.

  Show childrenHide children

  siretstring

  Cartes Bancaires SIRET. Format: 14 digits.

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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 childrenHide 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 childrenHide children

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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. 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.

  Show childrenHide children

  midNumberstring

  Max length: 14

  MID (Merchant ID) number. Required for merchants operating in Japan. Format: 14 numeric characters.

  reuseMidNumberboolean

  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.

  serviceLevelstring

  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.

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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. For merchants operating in Japan, request Diners payment method instead. Discover is automatically requested, together with Diners.

  Show childrenHide children

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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 childrenHide children

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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 childrenHide children

  supportEmailstring

  The email address of merchant support.

  girocardobject

  Girocard details.

  Show childrenHide children

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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 childrenHide 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 childrenHide children

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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 childrenHide children

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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. For merchants operating in Japan, midNumber, reuseMidNumber, and serviceLevel fields are required. For merchants operating outside of Japan, these fields are not required.

  Show childrenHide children

  midNumberstring

  Max length: 14

  MID (Merchant ID) number. Required for merchants operating in Japan.Format: 14 numeric characters.

  reuseMidNumberboolean

  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.

  serviceLevelstring

  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.

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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 childrenHide 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. In the US, maestro is not supported; use maestro_usa instead.

  Show childrenHide children

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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 childrenHide children

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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 childrenHide 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.

  nyceobject

  NYCE details.

  Show childrenHide children

  processingTypestring

  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 recurringProcessingModel Subscription.
  • ecom for all other card not present transactions. This includes non-recurring transactions and transactions with recurringProcessingModel CardOnFile or UnscheduledCardOnFile.

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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.

  paymeobject

  PayMe details.

  Show childrenHide children

  displayNamestring

  Merchant display name

  logostring

  Merchant logo. Format: Base64-encoded string.

  supportEmailstring

  The email address of merchant support.

  paypalobject

  PayPal details.

  Show childrenHide 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.

  pulseobject

  PULSE details.

  Show childrenHide children

  processingTypestring

  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 recurringProcessingModel Subscription.
  • ecom for all other card not present transactions. This includes non-recurring transactions and transactions with recurringProcessingModel CardOnFile or UnscheduledCardOnFile.

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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.

  referencestring

  Max length: 150

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

  shopperInteractionstring

  The sales channel.

  sodexoobject

  Sodexo details.

  Show childrenHide children

  merchantContactPhonestring

  Sodexo merchantContactPhone

  sofortobject

  Sofort details.

  Show childrenHide children

  currencyCodestring

  Sofort currency code. For example, EUR.

  logostring

  Sofort logo. Format: Base64-encoded string.

  starobject

  STAR details.

  Show childrenHide children

  processingTypestring

  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 recurringProcessingModel Subscription.
  • ecom for all other card not present transactions. This includes non-recurring transactions and transactions with recurringProcessingModel CardOnFile or UnscheduledCardOnFile.

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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.

  storeIdstring

  The ID of the store, if any.

  swishobject

  Swish details.

  • 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.

  Show childrenHide children

  swishNumberstring

  Min length: 10Max length: 10

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

  ticketobject

  Edenred details.

  Show childrenHide children

  requestorIdstring

  Ticket requestorId

  twintobject

  Twint details.

  Show childrenHide 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 childrenHide children

  logostring

  Vipps logo. Format: Base64-encoded string.

  subscriptionCancelUrlstring

  Vipps subscription cancel url (required in case of recurring payments)

  visaobject

  Visa details.

  Show childrenHide children

  transactionDescriptionobject

  Information regarding the transaction description.

  You cannot configure the transaction description in the test environment.

  Show childrenHide 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.

  wechatpayobject

  WeChat Pay details.

  Show childrenHide children

  contactPersonNamestring

  The name of the contact person from merchant support.

  emailstring

  The email address of merchant support.

  wechatpay_posobject

  WeChat Pay POS details.

  Show childrenHide children

  contactPersonNamestring

  The name of the contact person from merchant support.

  emailstring

  The 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.

  Show moreShow 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 childrenHide children

  InvalidFieldobject

  Show childrenHide 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 moreShow 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 childrenHide children

  InvalidFieldobject

  Show childrenHide 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 moreShow 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 childrenHide children

  InvalidFieldobject

  Show childrenHide 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 moreShow 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 childrenHide children

  InvalidFieldobject

  Show childrenHide 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 moreShow 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 childrenHide children

  InvalidFieldobject

  Show childrenHide 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 moreShow 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 childrenHide children

  InvalidFieldobject

  Show childrenHide 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.