# 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.6.0
Security: bearer, basic, apiKey

## Security:

  - `bearer` (unknown)
    http bearer JWT

  - `basic` (unknown)
    http basic

  - `apiKey` (unknown)
    apiKey in header X-API-Key

## Path parameters:

  - `id` (string, required)
    PayId assigned by Smart Collect 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)
    Test description

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

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

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

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

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

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

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

  - `amount.grossDiscount` (integer)
    Gross discount 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. It is recommended to limit the length to 18 characters so that it works for all payment methods. Allowed characters: (A-Z, a-z) and digits (0-9)

  - `captureMethod` (object)

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

  - `captureMethod.delayed` (object)

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

  - `expirationTime` (any)
    Transaction expiry timestamp (UTC).

  - `order` (object)

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

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

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

  - `order.description` (string)
    A short, description of the order (e.g. main product or order summary). In order to trigger a test payment that you want to run in simulation you can pass the simulation string. For example: "test:0000" to simulate a successful transaction.

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

  - `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` (integer)
    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` (integer)
    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` (integer)
    The net price of a single unit of this item, excluding tax and discounts.

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

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

  - `order.items.taxAmount` (integer)
    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` (integer)
    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` (integer)
    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.

  - `order.items.imageUrl` (string)

  - `order.items.productUrl` (string)

  - `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. Paygate 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.

  - `billingAddress.business` (string)
    Enum: "Company", "Person"

  - `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.phone` (object)
    Phone number of the customer.

  - `shipping.address.phone.countryCode` (string)
    Country Code/Area code of the phone number. Allows up to 3 digits. Must not contain the '+' prefix.

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

  - `shipping.address.salutation` (string)

  - `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.address.business` (string)
    Enum: "Company", "Person"

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

  - `credentialOnFile` (object)

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

  - `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", "BIWEEKLY", "MONTHLY", "MONTHLY_EOM", "BIMONTHLY", "QUARTERLY", "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` (integer)
    Total number of installments for a purchase.

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

  - `credentialOnFile.installments.purchaseAmount` (integer)
    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", "MONTHLY_EOM", "BIMONTHLY", "QUARTERLY", "YEARLY"

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

  - `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: "ORDER"

  - `paymentMethods.klarna` (object)

  - `paymentMethods.klarna.accessToken` (string)
    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.

## Request examples:

  - `Card` (unknown)

  - `Klarna` (unknown)

## Response 200:

  - `200` (unknown)
    Successful operation

## Response 200 fields (application/json):

  - `payId` (string)
    A unique identifier assigned by Smart Collect 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 Smart Collect.

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

  - `xId` (string)
    A unique identifier assigned by Smart Collect 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.

  - `order` (object)

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

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

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

  - `order.description` (string)
    A short, description of the order (e.g. main product or order summary). In order to trigger a test payment that you want to run in simulation you can pass the simulation string. For example: "test:0000" to simulate a successful transaction.

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

  - `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` (integer)
    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` (integer)
    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` (integer)
    The net price of a single unit of this item, excluding tax and discounts.

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

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

  - `order.items.taxAmount` (integer)
    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` (integer)
    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` (integer)
    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.

  - `order.items.imageUrl` (string)

  - `order.items.productUrl` (string)

  - `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".
    Enum: "BUSINESS", "INDIVIDUAL"

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

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

  - `customerInfo.email` (string)
    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. Allows up to 3 digits. Must not contain the '+' prefix.

  - `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` (any)
    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.

  - `paymentMethods` (object)

  - `paymentMethods.type` (string)
    Enum: "ALIPAY", "BANCOMATPAY", "BANCONTACT", "BIZUM", "BLIK", "CARD", "EPS", "GOOGLEPAY", "IDEAL", "KLARNA", "MBWAY", "MULTIBANCO", "PAYPAL", "SATISPAY", "UNIONPAY", "WECHAT", "WERO"

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

## Response 400:

  - `400` (unknown)
    Bad request, [https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400)

## Response 400 fields (application/json):

  - `errors` (object)
    "Object": [
"Error 1",
"Error 2"
]
}`

  - `type` (string)
    A URI reference that identifies the problem type

  - `title` (string)
    A short, human-readable summary of the problem type

  - `status` (string)
    The HTTP status code

  - `detail` (string)

  - `instance` (string)

## Response 422:

  - `422` (unknown)
    Unprocessable Entity, [https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422)

## Response 422 fields (application/json):

  - `merchantId` (string)
    Merchant ID assigned by Smart Collect.

  - `payId` (string)
    A unique identifier assigned by Smart Collect 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.

  - `xId` (string)
    A unique identifier assigned by Smart Collect 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.

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

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

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

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

  - `paymentPlanId` (string)

  - `paymentMethods` (object)

  - `paymentMethods.card` (object)

  - `paymentMethods.card.providerResponseCode` (string)
    Returned only when Acquirer is Clearhaus or MasaPay.

  - `paymentMethods.card.providerResponseText` (string)
    Returned only when Acquirer is Clearhaus or MasaPay. Information is passed only when status is FAILED.

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

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

  - `paymentMethods.eps` (object)

  - `paymentMethods.eps.providerResponseText` (string)
    Is returned only if Status=FAILED. Detailed PPRO error message.

  - `paymentMethods.bancontact` (object)

  - `paymentMethods.bancontact.providerResponseText` (string)

  - `paymentMethods.klarna` (object)

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

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

  - `paymentMethods.payPal` (object)

  - `paymentMethods.payPal.providerResponseCode` (string)

  - `paymentMethods.wero` (object)

  - `paymentMethods.wero.providerResponseText` (string)

  - `paymentMethods.wero.providerResponseCode` (string)

  - `type` (string)

  - `title` (string)

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

  - `detail` (string)

  - `instance` (string)

## Response 500:

  - `500` (unknown)
    Internal Server Error, [https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500)

## Response 500 fields (application/json):

  - `type` (string)

  - `title` (string)

  - `status` (string)

  - `detail` (string)

  - `instance` (string)

## Response 200 examples:

  - `Card` (unknown)

  - `Default` (unknown)

  - `GooglePay` (unknown)

  - `Klarna` (unknown)

  - `PayPal` (unknown)

## Response 422 examples:

  - `Klarna` (unknown)

