# Confirm payment This endpoint is used for payment methods that require a multi-step payment flow. It allows you to confirm a previously created payment instance (initiated via the Create Payment endpoint) to complete the transaction. This step is essential for certain payment methods to finalize the payment process. Endpoint: POST /payments/{id}/confirms Version: 2.0.0 Security: bearerAuth, basicAuth ## Path parameters: - `id` (string, required) PayId assigned by Axepta Online in the initial request ## 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. - `amount` (object, required) - `amount.value` (number, required) Total order amount in smallest currency unit including taxes, shipping costs, discounts, etc. - `amount.currency` (string, required) 3-character ISO currency code. - `amount.taxTotal` (number) Total tax amount. - `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. - `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 - `expirationTime` (string) Transaction expiry timestamp (UTC). Example: "2025-02-07T16:00:00Z" - `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. - `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. - `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. - `paymentMethods` (object) - `paymentMethods.card` (object) - `paymentMethods.card.eventToken` (string) Defines specific use cases of card payments, if applicable. - DELAYED_SHIPMENT: Passed to confirm the payment after the shipment is sent. - ORDER: Pass this to confirm the payment if you created the payment previously purely for authentication. Enum: "DELAYED_SHIPMENT", "ORDER" - `paymentMethods.klarna` (object) - `paymentMethods.klarna.accessToken` (string, required) Client token from Klarna received as a response to Create Payment request. Note: Access token is valid for 60 minutes. If you attempt to initiate confirm payment after 60 minutes, it will be rejected by Klarna. ## Response 200 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.klarna` (object) - `paymentMethods.klarna.providerTransactionId` (string) Transaction ID from Klarna. - `paymentMethods.klarna.billingAgreementId` (string) Consumer token from Klarna. This information is returned only when the initial request was sent with credentialOnFile.type as recurring and credentialOnFile.initialPayment as true. - `paymentMethods.klarna.redirectUrl` (string) The customer must be forwarded to this URL so that Klarna can place a Cookie. - `paymentMethods.klarna.providerResponseCode` (string) Response code from Klarna - `paymentMethods.klarna.providerResponseText` (string) Response description from Klarna. - `paymentMethods.payPal` (object) - `paymentMethods.payPal.providerResponseCode` (number) Error code from PayPal if agreed with Axepta Online Helpdesk. - `paymentMethods.riverty` (object) - `paymentMethods.riverty.providerResponseCode` (string) Response code from Riverty. - `paymentMethods.riverty.providerResponseText` (string) Response text from Riverty. - `paymentMethods.riverty.billingAddress` (object) - `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) Address line 2 of billing address. - `paymentMethods.riverty.billingAddress.addressLine3` (string) Address line 3 of billing address. - `paymentMethods.riverty.billingAddress.city` (string) City of billing address. - `paymentMethods.riverty.billingAddress.state` (string) State of billing address. - `paymentMethods.riverty.billingAddress.country` (string) 3 character ISO country code of billing address. - `paymentMethods.riverty.billingAddress.postalCode` (string) Postal code of billing address. - `paymentMethods.riverty.shippingAddress` (object) - `paymentMethods.riverty.shippingAddress.address` (object) - `paymentMethods.riverty.shippingAddress.address.firstName` (string) Shipping first name. - `paymentMethods.riverty.shippingAddress.address.lastName` (string) Shipping last name. - `paymentMethods.riverty.shippingAddress.address.companyName` (string) Shipping company name. Applicable, when the entity where the goods are being delivered is a business entity. - `paymentMethods.riverty.shippingAddress.address.streetName` (string) Shipping street. - `paymentMethods.riverty.shippingAddress.address.streetNumber` (string) Shipping street number. - `paymentMethods.riverty.shippingAddress.address.addressLine2` (string) Address line 2 of shipping address. - `paymentMethods.riverty.shippingAddress.address.addressLine3` (string) Address line 3 of shipping address. - `paymentMethods.riverty.shippingAddress.address.city` (string) Shipping city. - `paymentMethods.riverty.shippingAddress.address.state` (string) State of shipping address. - `paymentMethods.riverty.shippingAddress.address.country` (string) 3 character ISO country code of shipping address. - `paymentMethods.riverty.shippingAddress.address.postalCode` (string) Shipping postal code. - `paymentMethods.riverty.shippingAddress.type` (string) Shipping method. ## 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.klarna` (object) - `paymentMethods.klarna.providerResponseCode` (string) Response code from Klarna . - `paymentMethods.klarna.providerResponseText` (string) Response description from Klarna . ## Response 500 fields (application/json): - `responseCode` (string) Example: "A specific identifier for the error cause" - `responseDescription` (string) Example: "A brief message explaining the error"