# Create payment

This endpoint is used to initiate a payment for a specific payment method. You can choose between two integration types:
    HOSTED: Returns a URL for a payment method-specific hosted form, where the customer is redirected to securely complete the payment.
    DIRECT: Enables server-to-server communication, where you manage the payment UI and directly interacts with the API to process payments.

Note that not all payment methods support both HOSTED and DIRECT integration types. Some support only one of these options, while others support both. For detailed information about the supported integration types for each payment method, refer to the payment method-specific documentation in our product guide.

Endpoint: POST /payments
Version: 2.0.0
Security: bearerAuth, basicAuth

## Header parameters:

  - `Idempotency-Key` (string)
    A unique key provided by you to ensure that a particular operation is not processed multiple times in case of retries.

## Request fields (application/json):

  - `transId` (string, required)
    Transaction ID created in your system. It should be unique for each payment.

  - `externalIntegrationId` (string)
    External integration identifier

  - `refNr` (string)
    Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually.

  - `amount` (object, required)

  - `amount.value` (number, required)
    Total order amount in the smallest currency unit, including taxes, shipping costs, discounts, etc.

  - `amount.currency` (string, required)
    3-character ISO currency code.

  - `amount.taxTotal` (number)
    Total tax amount.

  - `amount.netItemTotal` (number)
    Total net amount of the products as part of the order, excluding shipping costs.

  - `amount.netShippingAmount` (number)
    Net shipping costs.

  - `amount.grossShippingAmount` (number)
    Gross shipping costs.

  - `amount.netDiscount` (number)
    Net discount amount.

  - `amount.grossDiscount` (number)
    Gross discount amount.

  - `language` (string)
    Language code to determine the language of the payment form and customer communication where applicable.

  - `captureMethod` (object)

  - `captureMethod.type` (string)
    Specifies the type of capture method being used.
    Enum: "AUTOMATIC", "MANUAL", "DELAYED"

  - `captureMethod.delayed` (object)

  - `captureMethod.delayed.delayedHours` (number)
    Defines the delay period, in hours, before an authorized payment is automatically captured. Required if type is delayed. Minimum: 1, maximum: 696

  - `credentialOnFile` (object)

  - `credentialOnFile.type` (string)
    Indicates the type of credential-on-file transaction.
    Enum: "RECURRING", "UNSCHEDULED", "INSTALLMENTS"

  - `credentialOnFile.initialPayment` (boolean)
    Specifies whether the transaction is the initial payment in a credential-on-file setup.

  - `credentialOnFile.recurring` (object)

  - `credentialOnFile.recurring.useCase` (string)
    Describes the use case for the unscheduled transaction.
    Enum: "FIXED", "FLEXIBLE_AMOUNT", "FLEXIBLE_FREQUENCY"

  - `credentialOnFile.recurring.frequency` (string)
    Defines the frequency of recurring payments.
    Enum: "DAILY", "WEEKLY", "MONTHLY", "YEARLY"

  - `credentialOnFile.recurring.startDate` (string)
    The date when the recurring payment schedule begins in YYYY-MM-DD format.

  - `credentialOnFile.recurring.expiryDate` (string)
    The date when the recurring payment schedule ends or expires in YYYY-MM-DD format.

  - `credentialOnFile.unscheduled` (object)

  - `credentialOnFile.unscheduled.subType` (string)
    Specifies the sub-type of an unscheduled credential-on-file transaction.
    Enum: "CIT", "MIT"

  - `credentialOnFile.installments` (object)

  - `credentialOnFile.installments.total` (number)
    Total number of installments for a purchase.

  - `credentialOnFile.installments.curIdx` (number)
    The index or sequence number of the current installment in the series.

  - `credentialOnFile.installments.purchaseAmount` (number)
    The total purchase amount being paid in installments.

  - `credentialOnFile.installments.frequency` (string)
    The frequency of installment payments, such as "daily", "weekly", "monthly", or "yearly".
    Enum: "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "YEARLY"

  - `credentialOnFile.installments.expiryDate` (string)
    The date when the installment plan ends or expires in YYYY-MM-DD format.

  - `order` (object)

  - `order.merchantReference` (string)
    A unique identifier for the order, assigned by your system.

  - `order.numberOfArticles` (number)
    The total number of articles (items) included in the order.

  - `order.creationDate` (string)
    The date and time when the order was created.

  - `order.invoiceId` (string)
    ID of the invoice generated for the order.

  - `order.items` (array)

  - `order.items.id` (string)
    A unique identifier for the specific item in the order.

  - `order.items.sku` (string)
    The Stock Keeping Unit (SKU) of the item, used to uniquely identify the product within the merchant's inventory.

  - `order.items.name` (string)
    The name or title of the item being purchased.

  - `order.items.type` (string)
    The type of item, such as "physical", "digital", "discount", "sales_tax", "shipping_fee", "discount", "gift_card", "store_credit", etc.

  - `order.items.quantity` (number)
    The quantity of this item being purchased in the order.

  - `order.items.quantityUnit` (string)
    The unit of measurement for the quantity, such as "pcs", "kg", or "liters".

  - `order.items.taxRate` (number)
    The tax rate applied to this item. Percentage sign must be replaced with two zeros. For example: A tax rate of 25% should be sent as 2500.

  - `order.items.netPrice` (number)
    The net price of a single unit of this item, excluding tax and discounts.

  - `order.items.grossPrice` (number)
    The gross price of a single unit of this item, including taxes but excluding discounts.

  - `order.items.discountAmount` (number)
    Discount amount applied to single unit of this item.

  - `order.items.taxAmount` (number)
    Tax amount applied to single unit of this item.

  - `order.items.merchantData` (string)
    Additional data or metadata provided by the merchant about this item.

  - `order.items.description` (string)
    Detailed description of the item.

  - `order.items.marketplaceSellerId` (string)
    An identifier for the seller in a marketplace context.

  - `order.items.lineNumber` (number)
    A sequential line number assigned to this item in the order for reference purposes.

  - `order.items.merchantProductType` (string)
    A classification or type assigned to this product by you.

  - `order.items.googleProductCategory` (string)
    Indicates the category of the item based on the Google product taxonomy.

  - `order.items.googleProductCategoryId` (number)
    Google product category ID.

  - `order.items.groupId` (string)
    An identifier used to group related items together.

  - `order.items.taxCategory` (string)
    Specifies the tax category applicable to this item.

  - `order.items.additionalDescription` (string)
    Any additional descriptive information about this item not covered elsewhere.

  - `order.items.productInfo` (object)

  - `order.items.productInfo.brand` (string)
    The brand name associated with this product.

  - `order.items.productInfo.categories` (array)
    The product's category path as used in the your webshop

  - `order.items.productInfo.globalTradeItemNumber` (string)
    The product's Global Trade Item Number (GTIN).
    Enum: "EAN", "ISBN", "UPC"

  - `order.items.productInfo.manufacturerPartNumber` (string)
    The product's Manufacturer Part Number (MPN), which - together with the brand - uniquely identifies a product. Only submit MPNs assigned by a manufacturer and use the most specific MPN possible.

  - `order.items.productInfo.imageUrl` (string)
    A URL pointing to an image of this product.

  - `order.items.productInfo.productUrl` (string)
    A URL linking to a detailed product page on the merchant's website.

  - `simulationMode` (string)
    Used to simulate a specific payment success or error use case. Accepts a list of predefined error codes.

  - `urls` (object)

  - `urls.return` (string)
    Mandatory when paymentMethods.integrationType=HOSTED. Not applicable for paymentMethods.integrationType=DIRECT.

  - `urls.cancel` (string)
    Mandatory when paymentMethods.integrationType=HOSTED. Not applicable for paymentMethods.integrationType=DIRECT.

  - `urls.webhook` (string)
    Mandatory when paymentMethods.integrationType=HOSTED. Not applicable for paymentMethods.integrationType=DIRECT.

  - `billingAddress` (object)

  - `billingAddress.streetName` (string)
    Street name of billing address.

  - `billingAddress.streetNumber` (string)
    Street number of billing address.

  - `billingAddress.addressLine2` (string)
    Address line 2 of billing address.

  - `billingAddress.addressLine3` (string)
    Address line 3 of billing address.

  - `billingAddress.city` (string)
    City of billing address.

  - `billingAddress.state` (string)
    State of billing address.

  - `billingAddress.country` (string)
    3 character ISO country code of billing address.

  - `billingAddress.postalCode` (string)
    Postal code of billing address.

  - `shipping` (object)

  - `shipping.address` (object)

  - `shipping.address.firstName` (string)
    Shipping first name.

  - `shipping.address.lastName` (string)
    Shipping last name.

  - `shipping.address.companyName` (string)
    Shipping company name. Applicable, when the entity where the goods are being delivered is a business entity.

  - `shipping.address.streetName` (string)
    Shipping street.

  - `shipping.address.streetNumber` (string)
    Shipping street number.

  - `shipping.address.addressLine2` (string)
    Address line 2 of shipping address.

  - `shipping.address.addressLine3` (string)
    Address line 3 of shipping address.

  - `shipping.address.city` (string)
    Shipping city.

  - `shipping.address.state` (string)
    State of shipping address.

  - `shipping.address.country` (string)
    3 character ISO country code of shipping address.

  - `shipping.address.postalCode` (string)
    Shipping postal code.

  - `shipping.type` (string)
    Shipping method.

  - `statementDescriptor` (string)
    Short, clear description of the transaction that appears on the customer's statement.

  - `customerInfo` (object)
    Information about the customer.

  - `customerInfo.merchantCustomerId` (string)
    A unique identifier for the customer, assigned by the merchant's system.

  - `customerInfo.customerType` (string)
    Specifies the type of customer, such as "individual" or "business".

  - `customerInfo.firstName` (string)
    First name of the customer.

  - `customerInfo.lastName` (string)
    Last name (surname) of the customer.

  - `customerInfo.email` (string, required)
    Email address of the customer.

  - `customerInfo.phone` (object)
    Phone number of the customer.

  - `customerInfo.phone.countryCode` (string)
    Country Code/Area code of the phone number.

  - `customerInfo.phone.number` (string)
    Phone number of the customer.

  - `customerInfo.salutation` (string)
    Salutation used to address the customer, such as "Mr", "Mrs", "Miss ".

  - `customerInfo.title` (string)
    Any additional title or designation associated with the customer, such as "Dr", etc.

  - `customerInfo.gender` (string)
    Gender of the customer.

  - `customerInfo.maidenName` (string)
    Maiden name of the customer.

  - `customerInfo.middleName` (string)
    Middle name of the customer.

  - `customerInfo.birthDate` (string)
    Birth date of the customer in YYYY-MM-DD format.

  - `customerInfo.birthPlace` (string)
    Place of birth of the customer.

  - `customerInfo.socialSecurityNumber` (string)
    Customer's Social Security Number.

  - `customerInfo.taxId` (string)
    Tax identification number associated with the customer.

  - `customerInfo.companyName` (string)
    Name of the company if the customer is a business entity.

  - `customerInfo.positionOccupied` (string)
    Position or role occupied by the individual within their company.

  - `customerInfo.companyRegistrationNumber` (string)
    Official registration number of the company in its country of incorporation.

  - `customerInfo.companyVatId` (string)
    Value Added Tax (VAT) identification number for the company.

  - `customerInfo.companyLegalForm` (string)
    The legal form or structure of the company.

  - `expirationTime` (string)
    Transaction expiry timestamp (UTC).
    Example: "2025-02-07T16:00:00Z"

  - `fraudData` (object)

  - `fraudData.accountInfo` (object)
    The account information contains optional information about the customer account with the merchant.

  - `fraudData.accountInfo.id` (string)
    The account ID of the cardholder within merchant environment / website (e.g. customer number).

  - `fraudData.accountInfo.authenticationInfo` (object)

  - `fraudData.accountInfo.authenticationInfo.method` (string)
    This data element specifies the mechanism used by the Cardholder to authenticate to the merchant.
    Enum: "GUEST", "MERCHANT_CREDENTIALS", "FEDERATED_ID", "ISSUER_CREDENTIALS", "THIRD_PARTY_AUTHENTICATION", "FIDO", "SIGNED_FIDO", "SRC_ASSURANCE_DATA"

  - `fraudData.accountInfo.authenticationInfo.timestamp` (string)
    Date and time (see RFC 3339) in UTC of the cardholder authentication. YYYY-MM-DDTHH:MM:SS+00:00.

  - `fraudData.accountInfo.authenticationInfo.data` (string)
    This data element can carry specific authentication attestation data such as FIDO if applicable.

  - `fraudData.accountInfo.ageIndicator` (string)
    Length of time that the customer has had the payment instrument / payment account with the merchant.
    Enum: "GUEST_CHECKOUT", "THIS_TRANSACTION", "LESS_THAN_30_DAYS", "FROM_30_TO_60_DAYS", "MORE_THAN_60_DAYS"

  - `fraudData.accountInfo.changeDate` (string)
    Date that the customer's payment instrument (account) with the merchant was last changed, including billing or shipping address, new payment account, or new user(s) added (YYYY-MM-DD).

  - `fraudData.accountInfo.changeIndicator` (string)
    Length of time since the customer’s account information with the merchant was last changed, including billing or shipping address, new payment account, or new user(s) added.
    Enum: "THIS_TRANSACTION", "LESS_THAN_30_DAYS", "FROM_30_TO_60_DAYS", "MORE_THAN_60_DAYS"

  - `fraudData.accountInfo.creationDate` (string)
    Date that the customer opened the account with the merchant in format YYYY-MM-DD.

  - `fraudData.accountInfo.passwordChangeDate` (string)
    Date that customer's account with the merchant had a password change or account reset in format YYYY-MM-DD.

  - `fraudData.accountInfo.passwordChangeDateIndicator` (string)
    Indicates the length of time since the customer account had a password change or account reset.
    Enum: "NO_CHANGE", "THIS_TRANSACTION", "LESS_THAN_30_DAYS", "FROM_30_TO_60_DAYS", "MORE_THAN_60_DAYS"

  - `fraudData.accountInfo.numberOfPurchases` (number)
    Number of purchases in the last 6 months

  - `fraudData.accountInfo.addCardAttemptsDay` (number)
    Number of Add Card attempts in the last 24 hours.

  - `fraudData.accountInfo.numberTransactionsDay` (number)
    Number of transactions (successful and abandoned) in the previous 24 hours.

  - `fraudData.accountInfo.numberTransactionsYear` (number)
    Number of transactions (successful and abandoned) in the previous year.

  - `fraudData.accountInfo.paymentAccountAge` (string)
    Date that the payment account was enrolled in the customer account in format YYYY-MM-DD.

  - `fraudData.accountInfo.paymentAccountAgeIndicator` (string)
    Indicates the length of time that the payment account was enrolled in the customer account.
    Enum: "GUEST_CHECKOUT", "THIS_TRANSACTION", "LESS_THAN_30_DAYS", "FROM_30_TO_60_DAYS", "MORE_THAN_60_DAYS"

  - `fraudData.accountInfo.shipAddressUsageDate` (string)
    Date when the shipping address used for this transaction was first used in format YYYY-MM-DD.

  - `fraudData.accountInfo.shipAddressUsageIndicator` (string)
    Indicates when the shipping address used for this transaction was first used.
    Enum: "THIS_TRANSACTION", "LESS_THAN_30_DAYS", "FROM_30_TO_60_DAYS", "MORE_THAN_60_DAYS"

  - `fraudData.accountInfo.suspiciousAccountActivity` (boolean)
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the customer account.

  - `fraudData.deliveryEmail` (string)
    For Electronic delivery, the email address to which the merchandise was delivered.

  - `fraudData.deliveryTimeframe` (string)
    Indicates the merchandise delivery timeframe.

  - `fraudData.giftCardAmount` (number)
    For prepaid or gift card purchase, the purchase amount total of prepaid or gift cards in smallest currency unit.

  - `fraudData.giftCardCount` (number)
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

  - `fraudData.giftCardCurrency` (number)
    For prepaid or gift card purchase, ISO 4217 three-digits numeric currency code of the gift card, e.g. 978.

  - `fraudData.preOrderDate` (string)
    For a pre-ordered purchase, the expected date that the merchandise will be available (YYYY-MM-DD).

  - `fraudData.preOrderPurchaseIndicator` (boolean)
    Indicates whether customer is placing an order for merchandise with a future availability or release date.

  - `fraudData.reorderItemsIndicator` (boolean)
    Indicates whether the customer is reordering previously purchased merchandise.

  - `fraudData.shippingAddressIndicator` (string)
    Indicates shipping method chosen for the transaction. If one or more items are included in the sale, use the Shipping Indicator code for the physical goods, or if all digital goods, use the Shipping Indicator code that describes the most expensive item.

  - `fraudData.ipZone` (string)
    Codes of countries from which you accept orders, 3 digits numeric according to ISO 3166-1. Separate several countries by commas: 036,040,124.

  - `fraudData.zone` (string)
    Codes of countries where you accept credit cards, 3 digits numeric or alphanumeric according to ISO 3166-1. Separate several countries by commas: 036,040,124.

  - `paymentFacilitator` (object)
    Object specifying SubMerchant (Payment Facilitator) details.

  - `paymentFacilitator.subMerchantId` (string)
    SubMerchantID assigned by the Payment Facilitator.

  - `paymentFacilitator.subMerchantName` (string)
    Name of the SubMerchantID.

  - `paymentFacilitator.subMerchantCity` (string)
    City of the SubMerchantID.

  - `paymentFacilitator.subMerchantCountry` (string)
    Country code of the SubMerchantID according to ISO-3166-1, alphanumeric 2 chars.

  - `paymentFacilitator.subMerchantStreet` (string)
    Street of the SubMerchantID.

  - `paymentFacilitator.subMerchantZip` (string)
    Postcode of the SubMerchantID.

  - `paymentFacilitator.subMerchantState` (string)
    State of the SubMerchantID.

  - `browserInfo` (object)

  - `browserInfo.acceptHeaders` (string)
    Exact content of the HTTP accept headers as sent from the customer’s browser.

  - `browserInfo.ipAddress` (string)
    IP address of the browser as returned by the HTTP headers.

  - `browserInfo.javaEnabled` (boolean)
    Represents the ability of the customer's browser to execute Java. Required when Browser JavaScript Enabled = true; otherwise Optional.

  - `browserInfo.javaScriptEnabled` (boolean)
    Represents the ability of the customer's browser to execute JavaScript.

  - `browserInfo.language` (string)
    Value representing the browser language as defined in IETF BCP47, returned from navigator.language property, e.g. "en", "de", "fr", "en-US", "en-GB", "de-DE", "de-AT", etc.

  - `browserInfo.colorDepth` (number)
    Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Required when Browser JavaScript Enabled = true; otherwise optional.

  - `browserInfo.screenHeight` (number)
    Total height of the Cardholder’s screen in pixels. Required when Browser JavaScript Enabled = true; otherwise optional.

  - `browserInfo.screenWidth` (number)
    Total width of the cardholder’s screen in pixels. Required when Browser JavaScript Enabled = true; otherwise optional.

  - `browserInfo.timeZoneOffset` (string)
    Time-zone offset in minutes between UTC and the Cardholder browser local time. Required when Browser JavaScript Enabled = true; otherwise optional.

  - `browserInfo.userAgent` (string)
    Exact content of the HTTP user-agent header.

  - `device` (object)

  - `device.deviceId` (string)
    Unique Device-ID.

  - `device.deviceType` (string)
    Enum: "DESKTOP", "TABLET", "SMARTPHONE"

  - `device.deviceOs` (string)
    Enum: "ANDROID", "IOS", "OTHERS"

  - `device.confidence` (number)
    A numerical value that indicates the level of confidence in the identification or verification of the customer's device. 0=no allocation, 100=absolutely safe allocation.

  - `device.newDevice` (boolean)
    Indicates whether the device being used is new or has not been previously recognized by the system.

  - `device.isAnonymousProxyUsed` (boolean)
    Specifies whether the customer is using an anonymous proxy to mask their IP address.

  - `device.isProxyUsed` (boolean)
    Indicates whether any kind of proxy is being used by the customer.

  - `device.country` (string)
    The country associated with the device's IP address.

  - `device.city` (string)
    The city associated with the device's IP address.

  - `device.latitude` (string)
    The latitude coordinate of the device's location.

  - `device.longitude` (string)
    The longitude coordinate of the device's location.

  - `device.fraudScore` (number)
    A numerical score that indicates the likelihood of fraudulent activity associated with the device.

  - `device.fraudScoreRules` (array)
    A list or description of the rules or criteria that contributed to the fraud score calculation for the device.

  - `device.browserLanguages` (array)
    A list of languages configured in the browser being used on the device.

  - `device.isMobileDevice` (boolean)
    Indicates whether the device being used is a mobile device.

  - `device.fraud` (string)
    Indicates whether the device has been flagged as potentially fraudulent based on predefined criteria. e.g. fraud, suspicion, nofraud.

  - `channel` (string)
    Specifies the sales or interaction channel through which the transaction is initiated. Examples include "online", "in-store", "mobile app".
    Enum: "ECOM", "MOTO", "APP", "PAYBYLINK", "POS"

  - `metadata` (object)
    A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Axepta Online will return the data as it is in the response.

  - `referencePayId` (string)
    Payment ID referring to the previous related request. Only applicable for PFConnect Authorization and Subsequent card installment payments.

  - `paymentMethods` (object)

  - `paymentMethods.integrationType` (string, required)
    Indicates the integration approach for the payment method.
- HOSTED: customer is redirected to a payment page,
- DIRECT: server to server communication
    Enum: "HOSTED", "DIRECT"

  - `paymentMethods.type` (string, required)
    Specifies the type of payment method being used.
    Enum: "APPLEPAY", "BANCONTACT", "BOLETO", "CARD", "DIRECTDEBIT", "EASYCOLLECT", "FLOAPAY", "GOOGLEPAY", "IDEAL", "KLARNA", "MOBILEPAY", "PAYPAL", "PAYU", "PFCONNECT", "RATEPAY", "RIVERTY", "SWISH", "VIPPS", "TRUSTLY", "WERO"

  - `paymentMethods.applePay` (object)

  - `paymentMethods.applePay.token` (string, required)
    PKPayment token received by you from Apple. Send the data as is in JSON structure.

  - `paymentMethods.applePay.merchantIdentifierOfPublicKey` (string)
    Merchant Identifier of Public Key. Mandatory if more then one Merchant Identifiers are stored with Axepta Online.

  - `paymentMethods.bancontact` (object)

  - `paymentMethods.bancontact.sellingPoint` (string)
    Selling point.

  - `paymentMethods.bancontact.service` (string)
    Products or service sold.

  - `paymentMethods.bancontact.account` (object, required)

  - `paymentMethods.bancontact.account.accountHolderName` (string, required)
    Name of account holder

  - `paymentMethods.bancontact.checkoutToken` (string)
    Card Token that merchant should store and provide in request to subsequent actions like Bancontact Recurring or One-Click Payment.Unique identifier of a card linked to the merchant. Can be used in subsequent WIP transactions only if the initial transaction has succeeded.

  - `paymentMethods.boleto` (object)

  - `paymentMethods.boleto.sellingPoint` (string)

  - `paymentMethods.card` (object)

  - `paymentMethods.card.eventToken` (string)
    Defines specific use cases of card payments, if applicable.
- DELAYED_SHIPMENT: Passed in initial request, if you intend to capture the request after the shipment is sent.
- PRE_AUTH: Passed in initial request, if the initial payment is a preauthorization.
- PLBS: Passed in initial request, if the payment is related to rental of goods and services and is being initiated as a preauthorization.
- ORDER: Pass if you want to perform authentication and payment in 2 steps. If you pass it, then the payment should be confirmed by calling the Confirm payment endpoint.
- REAUTHORIZATION: Passed in subsequent merchant initiated transaction. You can initiate a re-authorization when the 
completion or fulfillment of the original order or service extends beyond the authorization validity limit set by Visa.There
are two common re-authorization scenarios:
  - Split or delayed shipments at eCommerce retailers. A split shipment occurs when not all the goods ordered are
  available for shipment at the time of purchase. If the fulfillment of the goods takes place after the authorization
  validity limit set by Visa, eCommerce merchants perform a separate authorization to ensure that consumer funds are 
  available.
  - Extended stay hotels, car rentals, and cruise lines. A re-authorization is used for stays, voyages, and/or rentals that
  extend beyond the authorization validity period set by Visa.
- RESUBMISSION: Passed in subsequent merchant initiated transaction. You perform a re-submission in cases where it requested an authorization, but received a decline due to insufficient funds; however, the goods or services were already delivered to the cardholder.
  In such scenarios you can resubmit the request to recover outstanding debt from cardholders.
- DELAYED_CHARGES: Delayed charges are performed to process a supplemental account charge after original services have been rendered and respective payment has been processed.
- NO_SHOW: Passed in subsequent merchant initated transaction. Cardholders can use their Visa cards to make a guaranteed reservation with certain merchant segments. A guaranteed reservation ensures that the reservation will be honored and allows you to perform a No Show transaction to charge the cardholder a penalty according to the your  cancellation policy.
- ACCOUNT_VERIFICATION: Pass this if you want to verify card account without initiating a payment transaction. Amount is optional when this value is sent.
- ADDITIONAL_CHARGES
    Enum: "DELAYED_SHIPMENT", "PRE_AUTH", "PLBS", "ORDER", "REAUTHORIZATION", "RESUBMISSION", "DELAYED_CHARGES", "NO_SHOW", "ACCOUNT_VERIFICATION", "ADDITIONAL_CHARGES"

  - `paymentMethods.card.subType` (array)
    Used to define the card payment methods that needs to be shown on the payment form. The values here override your default configuration at merchant level.
    Enum: "AIRPLUS", "AMEX", "ARGENCARD", "AURA", "BANCONTACT", "CABAL", "CARTESBANCAIRES", "CBN", "CENCOSUD", "COMFORTCARD", "CUP", "DANKORT", "DINERS", "DISCOVER", "ELO", "HIPERCARD", "JCB", "LASER", "MAESTRO", "MASTERCARD", "NARANJA", "RUPAY", "SHOPPING", "TOTAL", "VISA"

  - `paymentMethods.card.number` (string)
    The card number, pseudo card number or the network token of the payment card.Mandatory when paymentMethod.integrationType=DIRECT.

  - `paymentMethods.card.cardHolderName` (string)
    The name of the cardholder as it appears on the payment card.Mandatory when paymentMethod.integrationType=DIRECT.

  - `paymentMethods.card.expiryDate` (string)
    The expiration date of the card in YYYYMM format.Mandatory when paymentMethod.integrationType=DIRECT.

  - `paymentMethods.card.brand` (string)
    The brand or network of the card, such as "visa", "mastercard".Applicable only when paymentMethod.integrationType=DIRECT.

  - `paymentMethods.card.securityCode` (string)
    The Card Security Code, also known as CVV or CVC.

  - `paymentMethods.card.startDate` (string)
    The start date of the card, if applicable. Applicable for some UK debit cards.Applicable only when paymentMethod.integrationType=DIRECT.

  - `paymentMethods.card.sequenceNumber` (string)
    A number assigned to specific cards by issuers to distinguish between multiple versions of the same card. Applicable for some UK debit cards.Applicable only when paymentMethod.integrationType=DIRECT.

  - `paymentMethods.card.brandSelection` (string)
    Indicates the party that made the card brand choice during the payment. Applicable only when paymentMethods.integrationType=DIRECT
Possible values:
- CUSTOMER: Customer made the brand choice during the payment
- MERCHANT: Originally selected brand by the merchant was not overriden by the customer during the payment
    Enum: "CUSTOMER", "MERCHANT"

  - `paymentMethods.card.tokenData` (object)
    Token data if you are connected to MDES and VTS directly.

  - `paymentMethods.card.tokenData.cryptogram` (string)
    Cryptogram as received from Tokenization Service.

  - `paymentMethods.card.tokenData.eci` (string)
    Payment system specific Electronic Commerce Indicator.

  - `paymentMethods.card.tokenData.tokenRequestor` (string)
    Token Requestor.
    Enum: "APPLEPAY", "GOOGLEPAY", "MERCHANT_TOKENIZATION"

  - `paymentMethods.card.tokenData.tokenRequestorId` (string)
    Token Requestor ID assigned by the card scheme.Required when tokenRequestor is MERCHANT_TOKENIZATION and MasterCard transaction.

  - `paymentMethods.card.schemeReferenceId` (string)
    A unique identifier assigned by the card network to track the transaction or card across its lifecycle. It is required to send this information for credential on file transactions when intialPayment is false.

  - `paymentMethods.card.approvalCodeTel` (string)
    For 3-D Secure: Telephone authorisation code.

  - `paymentMethods.card.priorAuthenticationInfo` (object)
    Prior Transaction Authentication Information contains optional information about a 3DS cardholder authentication that occurred prior to the current transaction

  - `paymentMethods.card.priorAuthenticationInfo.data` (string)
    Data that documents and supports a specific authentication process performed by the merchant such as FIDO

  - `paymentMethods.card.priorAuthenticationInfo.method` (string)
    The method used for prior authentication.
    Enum: "FRICTIONLESS", "ACS_CHALLENGE", "AVS_VERIFIED", "OTHER"

  - `paymentMethods.card.priorAuthenticationInfo.timestamp` (string)
    The timestamp of the prior authentication event in YYYY-MM-DDTHH:MM:SS+00:00 format

  - `paymentMethods.card.priorAuthenticationInfo.reference` (string)
    A reference to the prior authentication event. It should contain the ACS Transaction ID. For example: the first recurring transaction that was authenticated with the cardholder.

  - `paymentMethods.card.threeDsData` (object)

  - `paymentMethods.card.threeDsData.acsProtocolVersion` (string, required)
    The protocol version used for authentication.
    Enum: "1.0.2", "2.1.0", "2.2.0", "2.3.0"

  - `paymentMethods.card.threeDsData.authenticationValue` (string)
    Payment system specific value to provide proof of authentication.

  - `paymentMethods.card.threeDsData.cavvAlgorithm` (string)
    3DS 2.0 only with Cartes Bancaires.

  - `paymentMethods.card.threeDsData.serverTransactionId` (string)
    3DS 2.0 only. Universally unique transaction identifier assigned by the 3DS Server.

  - `paymentMethods.card.threeDsData.acsXid` (string)
    3DS 1.0 only. ACS assigned transaction ID.

  - `paymentMethods.card.threeDsData.dsTransactionId` (string)
    3DS 2.0 only. Universally unique transaction identifier assigned by the DS to identify a single transaction.

  - `paymentMethods.card.threeDsData.intermediateStatus` (string)
    This is the transaction status transStatus from the Authentication Response (ARes).
-  Y = Authentication Verification Successful.
-  N = Not Authenticated /Account Not Verified; Transaction denied.
-  U = Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq.
-  A = Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided.
-  C = Challenge Required; Additional authentication is required using the CReq/CRes.
-  D = Challenge Required; Decoupled Authentication confirmed.
-  I = Informational Only; 3DS Requestor challenge preference acknowledged.
    Enum: "Y", "N", "U", "A", "C", "D", "I"

  - `paymentMethods.card.threeDsData.finalStatus` (string)
    This is the transaction status transStatus from the Result Request (RReq).
-  Y = Authentication Verification Successful.
-  U = Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq.
-  A = Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided.
    Enum: "Y", "U", "A"

  - `paymentMethods.card.threeDsData.challengeRequestIndicator` (string)
    Specifies value for "3DS Requestor Challenge Indicator"
-  01 = No preference – default value if the data element is absent or not set to a value
-  02 = No authentication
-  03 = Authentication requested
-  04 = Authentication required
-  05 = No authentication: transaction risk analysis already performed
-  06 = No authentication: data share only
-  07 = No authentication: SCA already performed
-  08 = No authentication: whitelist
-  09 = Authentication required
    Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9

  - `paymentMethods.card.threeDsData.challengeCancellationIndicator` (string)
    Specifies value for "Challenge Cancellation Indicator"
-  01 = Cardholder selected “Cancel”
-  02 = 3DS Requestor cancelled Authentication.
-  03 = Transaction Abandoned
-  04 = Transaction Timed Out at ACS— other timeouts
-  05 = Transaction Timed Out at ACS— First CReq not received by ACS
-  06 = Transaction Error
-  07 = Unknown
    Enum: 1, 2, 3, 4, 5, 6, 7

  - `paymentMethods.card.threeDsData.dsScore` (string)
    Specifies value for "DS Score", scoring returned by the CB DS.

  - `paymentMethods.card.threeDsData.transactionStatusReason` (string)
    Specifies value for "Transaction Status Reason Code".
    Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 80, 81, 82, 83, 84, 85, 86, 87, 88

  - `paymentMethods.card.threeDsSDK` (object)

  - `paymentMethods.card.threeDsSDK.sdkApplicationId` (string)
    A unique identifier for the 3D Secure (3DS) SDK application used to facilitate authentication on the customer's device.

  - `paymentMethods.card.threeDsSDK.deviceData` (string)
    Data collected from the customer's device during the 3DS authentication process.

  - `paymentMethods.card.threeDsSDK.sdkEphemeralPublicKey` (string)
    The ephemeral public key generated by the 3DS SDK.

  - `paymentMethods.card.threeDsSDK.sdkReferenceNumber` (string)
    A reference number assigned to the 3DS SDK.

  - `paymentMethods.card.threeDsSDK.sdkTransactionId` (string)
    Unique identifier for the transaction generated by the 3DS SDK.

  - `paymentMethods.card.threeDsSDK.messageVersion` (string)
    The version of the 3D Secure protocol being used by the SDK.
    Enum: "2.1.0", "2.2.0", "LATEST"

  - `paymentMethods.card.threeDsPolicy` (object)
    Object specifying authentication policies and exemption handling strategies.

  - `paymentMethods.card.threeDsPolicy.skip` (string)
    Indicates whether and under which conditions authentication should be skipped or performed as data share only (dataOnly). By default, all transactions and SCA exemptions will be requested through EMV 3DS if not specified otherwise.
    Enum: "THIS_TRANSACTION", "OUT_OF_SCOPE", "DATA_ONLY"

  - `paymentMethods.card.threeDsPolicy.exemption` (object)

  - `paymentMethods.card.threeDsPolicy.exemption.reason` (string)
    Specifies the reason for requesting an exemption from 3DS authentication.
    Enum: "TRANSACTION_RISK_ANALYSIS", "DELEGATE_AUTHORITY", "LOW_VALUE", "TRUSTED_BENEFICIARY", "SECURE_CORPORATE_PAYMENT"

  - `paymentMethods.card.threeDsPolicy.exemption.merchantFraudRate` (number)
    Merchant fraud rate in bps taking into account all Merchant sites and card volumes, calculated as per PSD2 RTS Article 19. The merchant fraud rate is optional and has to be calculated by the Acquirer.

  - `paymentMethods.card.threeDsPolicy.challengePreference` (string)
    Indicates the merchant's preference for a 3DS challenge.
    Enum: "NO_PREFERENCE", "NO_CHALLENGE", "REQUEST_CHALLENGE", "MANDATE_CHALLENGE"

  - `paymentMethods.card.template` (object)
    Applicable only when paymentMethods.integrationType=HOSTED.

  - `paymentMethods.card.template.name` (string)
    The name of the card template being used for customization.

  - `paymentMethods.card.template.backgroundColor` (string)
    The background color of the card template, specified in hexadecimal format.

  - `paymentMethods.card.template.backgroundImage` (string)
    A URL pointing to an image used as the background of the card template.

  - `paymentMethods.card.template.textColor` (string)
    The color of the text on the card template, specified in hexadecimal format.

  - `paymentMethods.card.template.fontName` (string)
    The name of the font used for text on the card template.

  - `paymentMethods.card.template.fontSize` (number)
    The size of the text on the card template, specified in pixels (px).

  - `paymentMethods.card.template.tableWidth` (number)
    Specifies the width of a table element within the card template layout, specified in pixels (px).

  - `paymentMethods.card.template.tableHeight` (number)
    Specifies the height of a table element within the card template layout, specified in pixels (px).

  - `paymentMethods.card.template.customFields` (object)

  - `paymentMethods.card.template.customFields.customField1` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField2` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField3` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField4` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField5` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField6` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField7` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField8` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField9` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField10` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField11` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField12` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField13` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.template.customFields.customField14` (string)
    Customizable fields that can store additional data or display specific information on a card template.

  - `paymentMethods.card.prefillInfo` (object)
    Applicable only when paymentMethods.integrationType=HOSTED.

  - `paymentMethods.card.prefillInfo.number` (string)
    The card number or the pseudo card number of the payment card to prefill the form.

  - `paymentMethods.card.prefillInfo.cardholderName` (string)
    The name of the cardholder as it appears on the payment card to prefill the form.

  - `paymentMethods.card.prefillInfo.expiryDate` (string)
    The expiration date of the card in YYYYMM format to prefill the form.

  - `paymentMethods.card.prefillInfo.brand` (string)
    The brand or network of the card, such as "visa", "mastercard" to prefill the form.

  - `paymentMethods.card.prefillInfo.securityCode` (string)
    The Card Security Code, also known as CVV or CVC to prefill the form.

  - `paymentMethods.directDebit` (object)

  - `paymentMethods.directDebit.mandate` (object)

  - `paymentMethods.directDebit.mandate.mandateId` (string)
    SEPA Mandate number.

  - `paymentMethods.directDebit.mandate.dateOfSignature` (string)
    Date of issuing the mandate in the format DD.MM.YYYY.

  - `paymentMethods.directDebit.mandate.mandateUrl` (string)
    Valid URL pointing to the SEPA mandate, needs to be accessible by PPRO risk and compliance department. Required only in case of PPRO integration. Mandatory when credentialOnfile.type is UNSCHEDULED or RECURRING and credentialOnFile.initialPayment is true. Also mandatory when one off mandates are setup i.e. credentialOnFile object is not passed.

  - `paymentMethods.directDebit.method` (string)
    Direct debit in Germany=ELV, Netherlands=ENL, Austria=EEV
    Enum: "ELV", "ENL", "EEV"

  - `paymentMethods.directDebit.debitDelay` (number)
    For SEPA: Number of bank working days >0 which has to be added for the execution date of direct debit.

  - `paymentMethods.directDebit.template` (object)

  - `paymentMethods.directDebit.template.backgroundColor` (string)
    The background color of the card template,  specified in hexadecimal format.

  - `paymentMethods.directDebit.prefillInfo` (object)

  - `paymentMethods.easyCollect` (object)

  - `paymentMethods.easyCollect.accountId` (string)

  - `paymentMethods.easyCollect.contractId` (string)
    Underlying contract identifier.

  - `paymentMethods.easyCollect.contractDescription` (string)
    Underlying contract description.

  - `paymentMethods.easyCollect.businessIdentifier` (string)
    Unique SIREN Id of the merchant.

  - `paymentMethods.easyCollect.signatureAgreementType` (string)
    The way how the OneTimePassword (OTP) will be forwarded to the customer.
    Enum: "SMS", "EMAIL"

  - `paymentMethods.easyCollect.documentSignature` (boolean)
    The stamp is added on the last page of the mandate document.

  - `paymentMethods.easyCollect.googleAnalyticsConsent` (boolean)
    Debtor consent to use google analytics.

  - `paymentMethods.easyCollect.signatureBySca` (boolean)
    If "true" customer will be authenticated by AccountIdentificationService.

  - `paymentMethods.easyCollect.sps` (boolean)
    Allows to identify that WS call comes from SPS.

  - `paymentMethods.easyCollect.validation` (boolean)
    If Validation = TRUE --> ORG / If Validation = FALSE --> OTU

  - `paymentMethods.easyCollect.customerType` (string)
    Type of customer.
    Enum: "KNOWN", "PROSPECT"

  - `paymentMethods.easyCollect.mandateType` (string)
    Indicates whether the mandate is a business-to-business mandate or a customer-to-business mandate.
    Enum: "B2B", "CORE"

  - `paymentMethods.easyCollect.dueDate` (string)
    DueDate of this transaction. If missing the current day will be used. Pattern: YYYY-MM-DD

  - `paymentMethods.easyCollect.mandateId` (string)
    The mandate id which has been retrieved via EasyCollect.

  - `paymentMethods.easyCollect.signerPositionOccupied` (string)
    Title of the signatory's position in the company.

  - `paymentMethods.easyCollect.template` (string)
    Name of a XSLT template to get an individual layout for your EasyCollect form which matches with your shop layout. Details are available here: Corporate PayPage and templates.

  - `paymentMethods.floapay` (object)

  - `paymentMethods.floapay.providerMerchantId` (string)
    MerchantID provided by FLOA Pay.

  - `paymentMethods.floapay.providerMerchantSiteId` (string)
    MerchantSiteID provided by FLOA Pay.

  - `paymentMethods.floapay.merchantShopURL` (string)
    URL of the homepage of the merchant site.

  - `paymentMethods.floapay.deliveryChannel` (string)
    Merchant delivery method. "STD" is default value.

  - `paymentMethods.floapay.activationDelay` (number)
    Number of days of deferral.

  - `paymentMethods.googlePay` (object)

  - `paymentMethods.googlePay.token` (string, required)
    Token as received by you from Google. Data should be sent in JSON structure as received from Google.

  - `paymentMethods.ideal` (object)

  - `paymentMethods.ideal.subType` (string)
    Indicates the provider via which iDEAL payment should be processed.

Possible values:

- IDEAL - Processed directly with iDEAL
- IDEALPP - Processed via PPRO
- IDEALRABO - Processed via Rabo Bank
    Enum: "IDEAL", "IDEALPP", "IDEALRABO"

  - `paymentMethods.klarna` (object)

  - `paymentMethods.klarna.subType` (array)
    Payment Method Categories to show on the Payment Page. All available categories will be given to the customer if none is specified.Pass this when integrationType is HOSTED.
    Enum: "PAY_NOW", "DIRECT_DEBIT", "DIRECT_BANK_TRANSFER", "PAY_LATER", "PAY_OVER_TIME", "KLARNA"

  - `paymentMethods.klarna.layout` (object)
    Layout parameters for Klarna widgets.

  - `paymentMethods.klarna.layout.borderColor` (string)
    Color for the border of elements within the iFrame. Value should be a CSS hex color, e.g. "#FF9900".

  - `paymentMethods.klarna.layout.borderColorSelected` (string)
    Color for the border of elements within the iFrame when selected by the customer. Value should be a CSS hex color, e.g. "#FF9900".

  - `paymentMethods.klarna.layout.detailsColor` (string)
    Defines the color used for additional details or informational text.

  - `paymentMethods.klarna.layout.borderRadius` (string)
    Radius for the border of elements within the iFrame.

  - `paymentMethods.klarna.layout.showSubTotalDetail` (string)
    If the value is passed as "HIDE" then hides the item positions on the Klarna's hosted payment page.

  - `paymentMethods.klarna.layout.logoUrl` (string)
    URL of the logo to be displayed.

  - `paymentMethods.klarna.layout.pageTitle` (string)
    Title for the Payment Page.

  - `paymentMethods.klarna.accountId` (string)
    Within Axepta Online several Klarna user names can be stored on one MerchantID and controlled by the parameter Account. By default, please use the value "0", if you have several Klarna accounts, the values must be agreed with Axepta Online Helpdesk.

  - `paymentMethods.klarna.enhancedData` (array)

  - `paymentMethods.klarna.enhancedData.productCategory` (string)
    The name of the general category to which the specific goods belong, according to the selling merchant's categorization.
    Example: "Computers"

  - `paymentMethods.klarna.enhancedData.productName` (string)
    The name of the purchased good.
    Example: "Acer 5400"

  - `paymentMethods.klarna.description` (string)
    Description of the purpose of the token. Required when credentialOnfile.Type is recurring.InitialPayment is true.

  - `paymentMethods.klarna.billingAgreementId` (string)
    Provider Token returned in the response of initial payment of recurring flow. Required when credentialOnfile.Type is recurring and credentialOnfile.InitialPayment is false.

  - `paymentMethods.payPal` (object)

  - `paymentMethods.payPal.accountId` (string)
    Your Paypal account ID. It can be ID or email address associated with the Paypal account. This parameter can be passed to override the static merchant configuration if you have multiple Paypal accounts.

  - `paymentMethods.payPal.hideAddress` (boolean)
    Indicates if shipping address stored on customer's Paypal account should be hidden.

  - `paymentMethods.pfConnect` (object)

  - `paymentMethods.pfConnect.merchantCountryCode` (string)
    Country, where merchant operates.
    Enum: "FR", "IT"

  - `paymentMethods.pfConnect.financialProductId` (number, required)
    Financial product identifier.

  - `paymentMethods.pfConnect.shoppingBasketAmount` (number)
    Shopping basket amount. Mandatory only if also DownPaymentAmount is valorized.

  - `paymentMethods.pfConnect.downPaymentAmount` (number)
    Downpayment amount. Mandatory only if also ShoppingBasketAmount field is valorized.

  - `paymentMethods.pfConnect.deliveryDate` (string)
    Estimated delivery date. Mandatory if the merchant is operating in France.

  - `paymentMethods.pfConnect.customerRole` (string)
    Identifier role of the customer.
    Enum: "OWNER", "THIRD", "CUSTOMER"

  - `paymentMethods.pfConnect.partnerStoreId` (string)
    Merchant identifier assigned by PF. Mandatory for the merchants, which operates in Spain and Italy.

  - `paymentMethods.pfConnect.aboId` (number)
    SubscriptionID on PSP side. It will be used by axepta to identfy its merchant.Mandatory for the merchants, which operates in France.

  - `paymentMethods.pfConnect.applicationDate` (string)
    Date of the application for financing.Mandatory for merchants operating in France and optional for those operating in Spain.

  - `paymentMethods.pfConnect.customValue` (string)
    Value of the customProperties MerchantData.

  - `paymentMethods.pfConnect.programId` (string)
    Financial program ID.

  - `paymentMethods.pfConnect.quotationId` (string)
    ID of the quotation (value transmitted on the response of the CalculateQuotation).Mandatory for merchants operating in France.

  - `paymentMethods.ratepay` (object)

  - `paymentMethods.ratepay.deviceToken` (string)
    Device token generated by Ratepay's fingerprinting feature. Include the generated token if you are using the device fingerprinting feature in your integration.

  - `paymentMethods.ratepay.subType` (number, required)
    The payment option the buyer selected.
    Enum: "OPEN_INVOICE", "PAY_NOW"

  - `paymentMethods.ratepay.transferType` (number, required)
    The transfer type the buyer selected.
    Enum: "BANK_TRANSFER", "SEPA_DIRECT_DEBIT"

  - `paymentMethods.riverty` (object)

  - `paymentMethods.riverty.subType` (array)
    Indicates Rivertys sub payment method type.
    Enum: "INVOICE", "ACCOUNT", "INSTALLMENT", "CONSOLIDATEDINVOICE"

  - `paymentMethods.riverty.billingCareOf` (string)
    Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).

  - `paymentMethods.riverty.shippingCareOf` (string)
    Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).

  - `paymentMethods.riverty.profileNumber` (string)
    Profile number. Mandatory if subType is ACCOUNT or INSTALLMENT

  - `paymentMethods.riverty.orderRisk` (object)

  - `paymentMethods.riverty.orderRisk.channelType` (string)
    Order channel type.
    Enum: "INTERNET", "CATALOG", "CALLCENTER", "STATIONARY", "OTHER"

  - `paymentMethods.riverty.orderRisk.deliveryType` (string)
    Order delivery type.
    Enum: "NORMAL", "EXPRESS"

  - `paymentMethods.riverty.orderRisk.ticketDeliveryMethod` (string)
    Ticket's delivery method..
    Enum: "NOTSET", "PICKUP", "EMAIL", "POST", "PHONE"

  - `paymentMethods.riverty.customerRisk` (object)

  - `paymentMethods.riverty.customerRisk.existingCustomer` (boolean)
    Indicates whether the customer is an existing customer of the merchant.

  - `paymentMethods.riverty.customerRisk.verifiedCustomerIdentification` (boolean)
    Indicates whether the customer has been verified.

  - `paymentMethods.riverty.customerRisk.marketingOptIn` (boolean)
    Indicates whether marketing material is requested.

  - `paymentMethods.riverty.customerRisk.customerSince` (string)
    Date in format YYYY-MM-DD since which the customer has existed.

  - `paymentMethods.riverty.customerRisk.customerClassification` (string)
    Customer classification.

  - `paymentMethods.riverty.customerRisk.acquistitionChannel` (string)
    Indicates the channel via which the merchant is reached.
    Enum: "NOTSET", "ADVERTISEMENT", "SOCIALNETWORK", "DIRECT", "SEARCHENGINE", "OTHER"

  - `paymentMethods.riverty.customerRisk.hasCustomerCard` (boolean)
    Indicates whether the customer has a loyalty card.

  - `paymentMethods.riverty.customerRisk.customerCardSince` (string)
    Date in format YYYY-MM-DD since which the loyalty card has existed.

  - `paymentMethods.riverty.customerRisk.customerCardClassification` (string)
    Indicates the loyalty card level, e.g. "Gold Member".

  - `paymentMethods.riverty.customerRisk.profileTrackingId` (string)
    Unique TrackingID.

  - `paymentMethods.riverty.customerRisk.numberOfTransactions` (number)
    Number of successful transactions already completed by the customer.

  - `paymentMethods.riverty.customerRisk.customerIndividualScore` (number)
    Individual score for the customer supplied by the merchant.

  - `paymentMethods.riverty.customerRisk.userAgent` (string)
    UserAgent of this specific consumer.

  - `paymentMethods.riverty.customerRisk.amountOfTransactions` (number)
    Amount of paid orders last 12 months.

  - `paymentMethods.riverty.customerRisk.otherPaymentMethods` (boolean)
    Other payment method than MI in wallet.

  - `paymentMethods.riverty.eventToken` (string)
    Used to differentiate between single step and two step flow.
    Enum: "AUTHORIZATION", "LIST_PAYMENT_METHODS"

  - `paymentMethods.vipps` (object)

  - `paymentMethods.vipps.minAge` (number)
    Minimum age required for purchase. If specified, VIPPS will verify the customer's age before accepting payment.

  - `paymentMethods.trustly` (object)

  - `paymentMethods.trustly.templateUrl` (string)
    URL of your individual layout for the payment form.

## Response 201 fields (application/json):

  - `payId` (string)
    A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation.

  - `merchantId` (string)
    Merchant ID assigned by Axepta Online.

  - `transId` (string)
    Transaction ID provided by you in the request.

  - `xId` (string)
    A unique identifier assigned by Axepta Online for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same.

  - `refNr` (string)
    Reference number provided by you in the request.

  - `status` (string)
    Status of the transaction.

  - `responseCode` (string)
    Response code of the transaction.

  - `responseDescription` (string)
    Response description associated with the response code.

  - `metadata` (object)
    A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs as you passed in the request.

  - `paymentMethods` (object)

  - `paymentMethods.applePay` (object)

  - `paymentMethods.applePay.schemeReferenceId` (string)
    Unique identifier assigned by card schemes that is required to be sent in subsequent credential on file transactions.

  - `paymentMethods.boleto` (object)

  - `paymentMethods.boleto.paymentSlipLink` (string)
    Complete URL (URL-encoded) for the page which presents the payment form. This link should be displayed to the customer on the confirmation page.

  - `paymentMethods.card` (object)

  - `paymentMethods.card.cardHolderName` (string)
    The name of the cardholder as it appears on the payment card.

  - `paymentMethods.card.pseudoCardNumber` (string)
    Pseudo card number generated by Axepta Online, if the service is activated.

  - `paymentMethods.card.first6Digits` (string)
    First 6 digits of card.

  - `paymentMethods.card.last4Digits` (string)
    Last 4 digits of the card.

  - `paymentMethods.card.expiryDate` (string)
    The expiration date of the card in YYYYMM format.

  - `paymentMethods.card.brand` (string)
    The brand or network of the card, such as "visa", "mastercard".

  - `paymentMethods.card.product` (string)
    Card product name (if available) (e.g. 'Business Premium Debit').

  - `paymentMethods.card.source` (string)
    Card funding source (if available).
    Enum: "DEBIT", "CREDIT", "DEFERRED_DEBIT", "PREPAID", "CHARGE"

  - `paymentMethods.card.type` (string)
    The card type specifies the program, application or card level attached to the card if any (e.g. Classic, Standard, Gold, Business etc.).

  - `paymentMethods.card.issuer` (string)
    Card issuer (if available).

  - `paymentMethods.card.country` (string)
    Country the card was issued in.

  - `paymentMethods.card.bin` (object)

  - `paymentMethods.card.bin.accountBin` (string)
    The leading six digits of the account number also known as bank identification number (BIN). The BIN consists of 6 to 8 digits – because of PCI DSS rules a maximum of the first 6 digits may be output.

  - `paymentMethods.card.bin.accountRangeLow` (string)
    The account number at the low end of the account range.

  - `paymentMethods.card.bin.accountRangeHigh` (string)
    The account number at the high end of the account range.

  - `paymentMethods.card.versioningData` (object)
    Specific object for Card payment method.

  - `paymentMethods.card.versioningData.threeDSServerTransId` (string)

  - `paymentMethods.card.versioningData.acsStartProtocolVersion` (string)

  - `paymentMethods.card.versioningData.acsEndProtocolVersion` (string)

  - `paymentMethods.card.versioningData.dsStartProtocolVersion` (string)

  - `paymentMethods.card.versioningData.dsEndProtocolVersion` (string)

  - `paymentMethods.card.versioningData.threeDSMethodDataForm` (string)

  - `paymentMethods.card.versioningData.threeDSMethodUrl` (string)

  - `paymentMethods.card.versioningData.threeDSMethodData` (object)

  - `paymentMethods.card.versioningData.threeDSMethodData.threeDSMethodNotificationUrl` (string)

  - `paymentMethods.card.versioningData.errorDetails` (object)

  - `paymentMethods.card.versioningData.errorDetails.errorCode` (string)

  - `paymentMethods.card.versioningData.errorDetails.errorComponent` (string)

  - `paymentMethods.card.versioningData.errorDetails.errorDescription` (string)

  - `paymentMethods.card.fraudData` (object)

  - `paymentMethods.card.fraudData.zone` (string)
    If country codes have been entered in Zone Axepta Online returns the country code for the credit card or "UNKNOWN".

  - `paymentMethods.card.fraudData.ipZone` (string)
    If IP-countries are transmitted in IPZone in the case of the inquiry Axepta Online returns the country code of the IP address or "UNKNOWN".

  - `paymentMethods.card.fraudData.ipZoneA2` (string)
    If IPZone is submitted within the request Axepta Online returns the two-character country code of the IP address or "UNKNOWN". (DE=Germany, FR=France etc.)

  - `paymentMethods.card.fraudData.ipState` (string)
    If IPZone is submitted in the request Axepta Online returns the federal state from which the IP address of your customer originates.

  - `paymentMethods.card.fraudData.ipCity` (string)
    If IPZone is submitted in the request Axepta Online returns the town/city from which the IP address of your customer originates.

  - `paymentMethods.card.fraudData.ipLongitude` (string)
    If IPZone is submitted in the request Axepta Online returns the geographical longitude (floating point, decimal) of the dial-in node (PoP) of your customer.

  - `paymentMethods.card.fraudData.ipLatitude` (string)
    If IPZone is submitted in the request Axepta Online returns the geographical latitude (floating point, decimal) of the dial-in node (PoP) of your customer.

  - `paymentMethods.card.fraudData.fsStatus` (string)
    Only with EVO Payments International: ACCEPT=no suspicion of card fraud, DENY=refusal recommended, CHALLENGE= verification recommended, NOSCORE=No risk analysis, ENETFP=Exceptional error in the network, ERROR=Error in the data processing centre, ETMOUT=Timeout.

  - `paymentMethods.card.fraudData.fsCode` (string)
    Only with EVO Payments International: Recommended action:  no result,  accept,  always accept,  deny,  always deny,  suspicious,  please check,  suspicious ReD blacklist,  questionable,  questionable ReD blacklist,  threshold exceeded,  unusual usage,  intern ebitGuard error,  format error.

  - `paymentMethods.card.authenticationData` (object)
    Specific object for Card payment method.

  - `paymentMethods.card.authenticationData.acsChallengeMandated` (boolean)

  - `paymentMethods.card.authenticationData.acsDecConInd` (boolean)

  - `paymentMethods.card.authenticationData.acsOperatorId` (string)

  - `paymentMethods.card.authenticationData.acsReferenceNumber` (string)

  - `paymentMethods.card.authenticationData.acsRenderingType` (object)

  - `paymentMethods.card.authenticationData.acsRenderingType.acsInterface` (string)

  - `paymentMethods.card.authenticationData.acsRenderingType.acsUiTemplate` (string)

  - `paymentMethods.card.authenticationData.acsSignedContent` (string)

  - `paymentMethods.card.authenticationData.acsTransId` (string)

  - `paymentMethods.card.authenticationData.acsURL` (string)

  - `paymentMethods.card.authenticationData.authenticationType` (string)

  - `paymentMethods.card.authenticationData.authenticationValue` (string)

  - `paymentMethods.card.authenticationData.broadInfo` (string)

  - `paymentMethods.card.authenticationData.cardholderInfo` (string)

  - `paymentMethods.card.authenticationData.dsReferenceNumber` (string)

  - `paymentMethods.card.authenticationData.dsTransId` (string)

  - `paymentMethods.card.authenticationData.eci` (string)

  - `paymentMethods.card.authenticationData.messageExtension` (string)

  - `paymentMethods.card.authenticationData.messageType` (string)

  - `paymentMethods.card.authenticationData.messageVersion` (string)

  - `paymentMethods.card.authenticationData.sdkTransId` (string)

  - `paymentMethods.card.authenticationData.transStatus` (string)

  - `paymentMethods.card.authenticationData.transStatusReason` (string)

  - `paymentMethods.card.authenticationData.whiteListStatus` (string)

  - `paymentMethods.card.authenticationData.whiteListStatusSource` (string)

  - `paymentMethods.card.authenticationData.challengeRequest` (object)

  - `paymentMethods.card.authenticationData.challengeRequest.challengeWindowSize` (string)

  - `paymentMethods.card.authenticationData.base64EncodedChallengeRequest` (string)

  - `paymentMethods.card.authenticationData.threeDSCompInd` (string)

  - `paymentMethods.card.providerApprovalCode` (string)
    Approval code of the transaction.

  - `paymentMethods.card.providerResponseCode` (string)
    Provider response code.

  - `paymentMethods.card.providerResponseMessage` (string)
    Provider response text.

  - `paymentMethods.card.providerTransactionId` (string)
    Transaction ID assigned by the provider.

  - `paymentMethods.card.providerToken` (string)
    Provider's token.

  - `paymentMethods.card.providerMerchantId` (string)
    Provider Merchant ID.

  - `paymentMethods.card.providerTerminalId` (string)
    Provider Terminal ID.

  - `paymentMethods.card.providerOrderId` (string)
    Provider Order ID.

  - `paymentMethods.card.issuerResponseCode` (string)
    Issuer response code.

  - `paymentMethods.card.issuerResponseMessage` (string)
    Issuer response text.

  - `paymentMethods.directDebit` (object)

  - `paymentMethods.directDebit.mandateId` (string)
    SEPA Mandate ID for the transaction.

  - `paymentMethods.directDebit.dateOfSignature` (string)
    Date of issuing the mandate in format DD.MM.YYYY.

  - `paymentMethods.directDebit.account` (object)

  - `paymentMethods.directDebit.account.code` (string)
    Bank identifier code.

  - `paymentMethods.directDebit.account.number` (string)
    International bank account number.

  - `paymentMethods.directDebit.account.pseudoBankNumber` (string)
    Pseudo bank number if the service is active.

  - `paymentMethods.directDebit.account.accountHolderName` (string)
    Account holder name.

  - `paymentMethods.directDebit.account.bankName` (string)
    Bank name.

  - `paymentMethods.directDebit.providerResponseCode` (string)
    Provider response code

  - `paymentMethods.directDebit.providerResponseText` (string)
    Provider response text.

  - `paymentMethods.easyCollect` (object)

  - `paymentMethods.floapay` (object)

  - `paymentMethods.floapay.paymentDetails` (object)

  - `paymentMethods.floapay.paymentDetails.totalAmount` (number)

  - `paymentMethods.floapay.paymentDetails.schedule` (array)

  - `paymentMethods.floapay.paymentDetails.schedule.scheduleNumber` (number)

  - `paymentMethods.floapay.paymentDetails.schedule.repaymentDate` (string)

  - `paymentMethods.floapay.paymentDetails.schedule.repaymentAmount` (number)

  - `paymentMethods.googlePay` (object)

  - `paymentMethods.klarna` (object)

  - `paymentMethods.klarna.accessToken` (string)
    Client token from Klarna. In order to be able to subsequently show the Klarna widgets, the Klarna JavaScript-API must be initialized with this token.

  - `paymentMethods.klarna.subType` (array)
    Klarna sub payment methods that should be used to load the appropriate Klarna widgets.
    Enum: "PAY_NOW", "DIRECT_DEBIT", "DIRECT_BANK_TRANSFER", "PAY_LATER", "PAY_OVER_TIME", "KLARNA"

  - `paymentMethods.klarna.providerResponseCode` (string)
    Response code from Klarna.

  - `paymentMethods.klarna.provideResponseText` (string)
    Response description from Klarna.

  - `paymentMethods.payPal` (object)

  - `paymentMethods.payPal.orderId` (string)
    Unique order identifier assigned by Paypal that should be used to construct the URL for the smart button	.

  - `paymentMethods.pfConnect` (object)

  - `paymentMethods.pfConnect.financingScenarioDetail` (string)
    A set of quotations (simulations variations) calculated for a Financeable and FinancialProduct pair.Contains financial product data for a previous initialization. They are returned in JSON format.

  - `paymentMethods.ratepay` (object)

  - `paymentMethods.ratepay.authorizationExpiry` (string)
    The date and time when remaining un-cancelled and un-captured authorized amount will be automatically cancelled. Available only for successful responses HTTP 201.

  - `paymentMethods.ratepay.paymentReference` (string)
    Purpose to be indicated in the bank transfer (generated by Ratepay). Provided only when paymentMethod.ratepay.transferType is sent as BANK_TRANSFER in request.

  - `paymentMethods.ratepay.providerTransactionId` (string)
    ID of transaction generated by Ratepay during authorization. A transaction ID is generated for both accepted and declined transactions.

  - `paymentMethods.riverty` (object)

  - `paymentMethods.riverty.allowedPaymentMethod` (array)

  - `paymentMethods.riverty.allowedPaymentMethod.type` (string)
    Available payment method. Possible values: "Invoice", "Account", "Installment", "Consolidatedinvoice".

  - `paymentMethods.riverty.allowedPaymentMethod.campaigns` (array)

  - `paymentMethods.riverty.allowedPaymentMethod.campaigns.campaignNo` (number)
    Campaign number.

  - `paymentMethods.riverty.allowedPaymentMethod.campaigns.description` (string)
    Campaign description.

  - `paymentMethods.riverty.allowedPaymentMethod.installment` (object)

  - `paymentMethods.riverty.allowedPaymentMethod.installment.basketAmount` (string)
    Available payment method.
    Enum: "INVOICE", "ACCOUNT", "INSTALLMENT", "CONSOLIDATED_INVOICE"

  - `paymentMethods.riverty.allowedPaymentMethod.installment.numberOfInstallments` (number)
    Number of installments.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.installmentAmount` (string)
    Installment amount for each month.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.firstInstallmentAmount` (string)
    First installment amount.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.lastInstallmentAmount` (string)
    Final installment amount.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.interestRate` (string)
    Interest rate.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.effectiveInterestRate` (string)
    Effective interest rate.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.effectiveAnnualPercentageRate` (string)
    Effective annual percentage.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.totalInterestAmount` (string)
    Total interest rate.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.startupFee` (string)
    Starting fee.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.monthlyFee` (string)
    Monthly fee.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.totalAmount` (string)
    Total amount.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.installmentProfileNumber` (string)
    Installment profile number.

  - `paymentMethods.riverty.allowedPaymentMethod.installment.readMore` (string)
    Further information about the installment process.

  - `paymentMethods.riverty.allowedPaymentMethod.legalInfo` (object)

  - `paymentMethods.riverty.allowedPaymentMethod.legalInfo.requiresCustomerConsent` (number)
    "true", if customer consent is required.

  - `paymentMethods.riverty.allowedPaymentMethod.legalInfo.termsAndConditionsUrl` (string)
    URL to Terms and Conditions.

  - `paymentMethods.riverty.allowedPaymentMethod.legalInfo.privacyStatementUrl` (string)
    URL to Privacy Statement.

  - `paymentMethods.riverty.allowedPaymentMethod.legalInfo.bgb507Url` (string)
    URL to § 507 BGB.

  - `paymentMethods.riverty.allowedPaymentMethod.legalInfo.text` (string)
    Legal text.

  - `paymentMethods.riverty.billingAddress` (object)

  - `paymentMethods.riverty.billingAddress.country` (string)
    2 character ISO country code of billing address.
    Enum: "NO", "SE", "FI", "DK", "DE", "AT", "CH", "NL", "BE"

  - `paymentMethods.riverty.billingAddress.postalCode` (string)
    Postal code of billing address.

  - `paymentMethods.riverty.billingAddress.city` (string)
    City of billing address.

  - `paymentMethods.riverty.billingAddress.streetName` (string)
    Street name of billing address.

  - `paymentMethods.riverty.billingAddress.streetNumber` (string)
    Street number of billing address.

  - `paymentMethods.riverty.billingAddress.addressLine2` (string)
    Street number addition.

  - `paymentMethods.riverty.billingAddress.addressLine3` (string)
    Responsible person for dispatch of shipment.

  - `paymentMethods.riverty.shippingAddress` (object)

  - `paymentMethods.riverty.shippingAddress.countryCode` (string)
    Shipping country code.

  - `paymentMethods.riverty.shippingAddress.postalCode` (string)
    Shipping postal code.

  - `paymentMethods.riverty.shippingAddress.city` (string)
    Shipping city.

  - `paymentMethods.riverty.shippingAddress.streetName` (string)
    Shipping street.

  - `paymentMethods.riverty.shippingAddress.streetNumber` (string)
    Shipping street number.

  - `paymentMethods.riverty.providerResponseCode` (string)
    Response code from Riverty.

  - `paymentMethods.riverty.providerResponseText` (string)
    Response text from Riverty.

  - `paymentMethods.swish` (object)

## Response 202 fields (application/json):

  - `_links` (object)

  - `_links.redirect` (object)
    This link is present when redirection to payment page must be done in order to complete the payment process. Decoded URL value with the exception of PagBrasil Boleto Bancario, where the encoded URL value is returned.

  - `_links.redirect.href` (string)
    The URL to which the customer should be redirected to complete the payment.

  - `_links.redirect.type` (string)
    Specifies the type of redirect link.

## Response 400 fields (application/json):

  - `field` (string)
    Example: "transId"

  - `error` (string)
    Example: "This field is required."

## Response 422 fields (application/json):

  - `payId` (string)
    A unique identifier assigned by Axepta Online to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation.

  - `merchantId` (string)
    Merchant ID assigned by Axepta Online.

  - `transId` (string)
    Transaction ID provided by you in the request.

  - `xId` (string)
    A unique identifier assigned by Axepta Online for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same.

  - `refNr` (string)
    Reference number provided by you in the request.

  - `status` (string)
    Status of the transaction.

  - `responseCode` (string)
    Response code of the transaction.

  - `responseDescription` (string)
    Response description associated with the response code.

  - `metadata` (object)
    A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs as you passed in the request.

  - `paymentMethods` (object)

  - `paymentMethods.card` (object)

  - `paymentMethods.card.providerResponseCode` (string)
    Provider response code.

  - `paymentMethods.card.providerResponseMessage` (string)
    Provider response text.

  - `paymentMethods.card.issuerResponseCode` (string)
    Issuer response code.

  - `paymentMethods.card.issuerResponseMessage` (string)
    Issuer response text.

  - `paymentMethods.directDebit` (object)

  - `paymentMethods.directDebit.providerResponseText` (string)
    Provider response text.

  - `paymentMethods.easyCollect` (object)

  - `paymentMethods.floapay` (object)

  - `paymentMethods.floapay.providerResponseText` (string)
    Error text from FLOA Pay.

  - `paymentMethods.floapay.providerResponseCode` (string)
    Error code from FLOA Pay.

  - `paymentMethods.klarna` (object)

  - `paymentMethods.klarna.providerResponseCode` (string)
    Response code from Klarna	.

  - `paymentMethods.klarna.providerResponseText` (string)
    Response description from Klarna	.

  - `paymentMethods.ratepay` (object)

  - `paymentMethods.ratepay.providerDeclineCategory` (string)
    Decline category provider by Ratepay. See Decline Categories for details.

  - `paymentMethods.ratepay.providerResponseText` (string)
    A message from Ratepay describing which constraint was violated.

  - `paymentMethods.ratepay.providerResponseCode` (string)
    List of none, one or multiple reasons why the request was declined. See Decline Categories to learn about possible reasons for each decline category.

  - `paymentMethods.swish` (object)

## Response 500 fields (application/json):

  - `responseCode` (string)
    Example: "A specific identifier for the error cause"

  - `responseDescription` (string)
    Example: "A brief message explaining the error"