# Capture payment

This endpoint is used to capture an existing authorized payment.

Endpoint: POST /payments/{id}/captures
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)

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

  - `statementDescriptor` (string)
    Short, clear description of the transaction that appears on the customer's statement. It is recommend sending a maximum of 22 characters. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters / - ? : ( ) . , +

  - `captureMethod` (object)

  - `captureMethod.manual` (object)

  - `captureMethod.manual.currentSequence` (integer)
    Represents the sequence number of the current manual capture in a series of captures for a single transaction. Relevant for multiple partial captures.

  - `captureMethod.manual.final` (boolean)
    Indicates whether the current manual capture is the final capture for the transaction. Relevant for multiple partial captures.True means final capture.False means not a final capture.

  - `captureMethod.manual.total` (integer)
    Indicates the total number of partial captures will be sent.

  - `enhancedData` (object)

  - `enhancedData.common` (object, required)

  - `enhancedData.common.amounts` (object)

  - `enhancedData.common.amounts.grossAmount` (integer)

  - `enhancedData.common.amounts.netAmount` (integer)

  - `enhancedData.common.amounts.taxAmount` (integer)

  - `enhancedData.common.tax` (object)

  - `enhancedData.common.tax.taxRate` (integer)

  - `enhancedData.common.tax.taxTypeIndicator` (string)
    Enum: "VALUE_ADDED_TAX", "SALES_TAX", "OTHER"

  - `enhancedData.carRental` (object)

  - `enhancedData.carRental.common` (object)

  - `enhancedData.carRental.common.rentalAgreementNumber` (string)

  - `enhancedData.carRental.common.rentalStart` (any)
    Date and Time are both passed.

  - `enhancedData.carRental.common.return` (any)
    Date and Time are both passed.

  - `enhancedData.carRental.common.pickupLocation` (object)

  - `enhancedData.carRental.common.pickupLocation.street` (string)

  - `enhancedData.carRental.common.pickupLocation.city` (string)

  - `enhancedData.carRental.common.pickupLocation.zipCode` (string)

  - `enhancedData.carRental.common.pickupLocation.state` (string)

  - `enhancedData.carRental.common.pickupLocation.country` (string)

  - `enhancedData.carRental.common.daysHired` (integer)

  - `enhancedData.carRental.common.carClass` (string)

  - `enhancedData.carRental.common.carRegistrationNumber` (string)

  - `enhancedData.carRental.common.renterName` (string)

  - `enhancedData.carRental.common.noShowIndicator` (boolean)

  - `enhancedData.carRental.common.reservationNumber` (string)

  - `enhancedData.carRental.common.rentalDetails` (object)

  - `enhancedData.carRental.common.rentalDetails.salesIndicator` (string)
    Enum: "D", "F", "R"

  - `enhancedData.carRental.common.rentalDetails.rentalRate` (string)

  - `enhancedData.carRental.common.rentalDetails.orderNumber` (string)

  - `enhancedData.carRental.common.rentalDetails.folioNumber` (string)

  - `enhancedData.carRental.common.rentalDetails.serviceDescription` (string)

  - `enhancedData.carRental.common.rentalDetails.oneWayServiceCharge` (integer)

  - `enhancedData.carRental.common.extraCharges` (object)

  - `enhancedData.carRental.common.extraCharges.amount` (integer)

  - `enhancedData.carRental.common.extraCharges.reason` (string)
    Enum: "NONE", "FUEL", "EXTRA_MILEAGE", "LATE_RETURN", "ONE_WAY_SERVICE", "PARKING_VIOLATION"

  - `enhancedData.carRental.common.pointOfSale` (object)

  - `enhancedData.carRental.common.pointOfSale.type` (string)

  - `enhancedData.carRental.common.pointOfSale.url` (string)

  - `enhancedData.carRental.common.pointOfSale.email` (string)

  - `enhancedData.carRental.common.pointOfSale.phone` (string)

  - `enhancedData.carRental.airPlus` (object)

  - `enhancedData.carRental.airPlus.rentalInformation` (object)

  - `enhancedData.carRental.airPlus.rentalInformation.carMake` (string)

  - `enhancedData.carRental.airPlus.rentalInformation.departureDate` (any)
    In format: YYYY-MM-DD

  - `enhancedData.carRental.airPlus.rentalInformation.fuelConsumption` (integer)

  - `enhancedData.carRental.airPlus.rentalInformation.customerOrderNumber` (string)

  - `enhancedData.carRental.airPlus.rentalInformation.costPerMile` (integer)

  - `enhancedData.carRental.airPlus.rentalInformation.milesDriven` (integer)

  - `enhancedData.carRental.airPlus.rentalInformation.driver` (object)

  - `enhancedData.carRental.airPlus.rentalInformation.driver.firstName` (string)

  - `enhancedData.carRental.airPlus.rentalInformation.driver.middleName` (string)

  - `enhancedData.carRental.airPlus.rentalInformation.driver.lastName` (string)

  - `enhancedData.carRental.airPlus.rentalInformation.vehicleGroup` (string)

  - `enhancedData.carRental.airPlus.rentalInformation.carRentalCompanyId` (string)
    Enum: "D", "F", "G", "H", "M", "O", "P", "T", "W", "Y", "Z"

  - `enhancedData.carRental.airPlus.mileageUnit` (string)
    Enum: "KM", "MI"

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation` (object)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.accountingUnit` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.businessUnit` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.actionNumber` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.voucherNumber` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.department` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.discountNumber` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.internalAccountNumber` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.costCenter` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.customerNumber` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.customerReference` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.employeeNumber` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.projectNumber` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.invoiceDate` (any)
    In format: YYYY-MM-DD

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.invoiceNumber` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.destination` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.taxRegistrationNumber` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.comments` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.misc` (string)

  - `enhancedData.carRental.airPlus.billingAndInvoiceInformation.countryCode` (string)

  - `enhancedData.carRental.airPlus.odometerStart` (integer)

  - `enhancedData.carRental.airPlus.odometerReturn` (integer)

  - `enhancedData.carRental.airPlus.telcoUnits` (integer)

  - `enhancedData.carRental.airPlus.carSharing` (object)

  - `enhancedData.carRental.airPlus.carSharing.nonVATableNetAmount` (integer)

  - `enhancedData.carRental.airPlus.carSharing.taxTypeIndicator` (string)
    Enum: "NOVAT", "NONDEDUCTIBLE_CITY_VAT", "NONDEDUCTIBLE_STATE", "DEDUCTIBLE_CITY_VAT", "DEDUCTIBLE_STATE", "DEDUCTIBLE_NATIONAL_VAT", "EU_REVERSE_CHARGE"

  - `enhancedData.carRental.airPlus.carSharing.documentNumber` (string)
    Size: 10, internal document number of the related service as printed on the voucher, train-ticket, etc.

  - `enhancedData.carRental.airPlus.carSharing.serviceDescription` (string)
    Size: 135, will be parsed into 3 sub-fields with 45 digits each

  - `enhancedData.carRental.airPlus.carSharing.serviceType` (string)

  - `enhancedData.carRental.airPlus.carSharing.hotelBookingDetails` (object)

  - `enhancedData.carRental.airPlus.carSharing.hotelBookingDetails.name` (string)

  - `enhancedData.carRental.airPlus.carSharing.hotelBookingDetails.checkInDate` (any)
    In format: YYYY-MM-DD

  - `enhancedData.carRental.airPlus.carSharing.hotelBookingDetails.locationCity` (string)

  - `enhancedData.carRental.airPlus.carSharing.hotelBookingDetails.roomNights` (string)

  - `enhancedData.carRental.airPlus.lineItems` (array)

  - `enhancedData.carRental.airPlus.lineItems.description` (string)
    Enum: "C9", "CB", "CC", "CG", "CI", "CJ", "CT", "CU", "CV", "CW", "CX", "CY", "D4", "D7", "D8", "D9", "DA", "O6", "OQ"

  - `enhancedData.carRental.amex` (object)

  - `enhancedData.carRental.amex.cancellationReason` (string)

  - `enhancedData.carRental.amex.bookingSourceCode` (string)
    Enum: "ONLINE_BOOKING", "SELF_BOOKING_TOOL", "AFTER_HOURS_BOOKING", "PHONE_BOOKING"

  - `enhancedData.carRental.amex.mediaCode` (string)
    Enum: "CARDMEMBER_SIGNATURE_ON_FILE", "PHONE_ORDER", "MAIL_ORDER", "INTERNET_ORDER", "RECURRING_BILLING"

  - `enhancedData.carRental.amex.globalDistributionSystem` (string)
    Enum: "AMADEUS", "SABRE", "GALILEO"

  - `enhancedData.carRental.amex.originalAmount` (integer)

  - `enhancedData.carRental.amex.originalCurrencyCode` (string)

  - `enhancedData.carRental.amex.additionalAmounts` (array)

  - `enhancedData.carRental.amex.additionalAmounts.amountTypeCode` (string)

  - `enhancedData.carRental.amex.additionalAmounts.transactionType` (string)
    Enum: "DEBIT", "CREDIT"

  - `enhancedData.carRental.amex.destination` (string)

  - `enhancedData.carRental.amex.departureDate` (any)
    In format: YYYY-MM-DD

  - `enhancedData.carRental.amex.travellers` (array)

  - `enhancedData.carRental.amex.consultant` (string)

  - `enhancedData.carRental.amex.mileageUnit` (string)
    Enum: "KM", "MI"

  - `enhancedData.carRental.amex.milesDriven` (integer)

  - `enhancedData.carRental.amex.supplier` (object)

  - `enhancedData.carRental.amex.supplier.name` (string)

  - `enhancedData.carRental.amex.supplier.taxRegistrationNumber` (string)

  - `enhancedData.carRental.amex.supplier.matchCode` (string)

  - `enhancedData.carRental.amex.supplier.legalName` (string)

  - `enhancedData.carRental.amex.provider` (object)

  - `enhancedData.carRental.amex.provider.travelAgencyCode` (string)

  - `enhancedData.carRental.amex.provider.travelOfficeCode` (string)

  - `enhancedData.carRental.amex.provider.transactionReference` (string)

  - `enhancedData.carRental.amex.provider.invoiceIndicator` (string)
    Enum: "N", "Y", "R"

  - `enhancedData.carRental.amex.provider.invoice` (object)

  - `enhancedData.carRental.amex.provider.invoice.number` (string)

  - `enhancedData.carRental.amex.provider.invoice.date` (any)
    In format: YYYY-MM-DD

  - `enhancedData.carRental.amex.provider.invoice.associatedNumber` (string)

  - `enhancedData.carRental.amex.provider.iataNumber` (integer)

  - `enhancedData.carRental.amex.provider.serviceCentre` (string)

  - `enhancedData.carRental.amex.provider.terminalId` (string)

  - `enhancedData.carRental.amex.provider.providerReference` (string)

  - `enhancedData.carRental.amex.provider.electronicInvoiceLocation` (string)

  - `enhancedData.carRental.amex.bookingSystem` (object)

  - `enhancedData.carRental.amex.bookingSystem.bookingSystemReference` (string)

  - `enhancedData.carRental.amex.customerReference` (array)

  - `enhancedData.carRental.amex.customerReference.statementField` (string)
    The number indicates which reference field on the statement that the customer wishes to see this data in

  - `enhancedData.carRental.amex.customerReference.typeCode` (string)
    Enum: "COST_CENTRE", "EMPLOYEE_ID", "TRAVEL_BOOKER_NAME", "JOB_NUMBER", "PROJECT_CODE", "BUSINESS_UNIT", "OTHER"

  - `enhancedData.carRental.amex.customerReference.data` (string)

  - `enhancedData.carRental.amex.lineItems` (array)

  - `enhancedData.carRental.amex.lineItems.number` (string)

  - `enhancedData.carRental.amex.lineItems.description` (string)

  - `enhancedData.carRental.amex.lineItems.reference` (string)

  - `enhancedData.carRental.amex.lineItems.statementIndicator` (string)
    Enum: "N", "Y", "R"

  - `enhancedData.carRental.amex.lineItems.grossAmount` (integer)

  - `enhancedData.carRental.amex.lineItems.transactionType` (string)
    Enum: "DEBIT", "CREDIT"

  - `enhancedData.carRental.amex.lineItems.additionalAmounts` (array)

  - `paymentMethods` (object)

  - `paymentMethods.card` (object)

  - `paymentMethods.card.finishAuth` (boolean)
    Transmit value in order to stop the renewal of guaranteed authorisations and rest amounts after partial captures. Use this parameter only if you are using the additional function ETM (Extended Transactions Managament).

  - `paymentMethods.klarna` (object)

  - `paymentMethods.klarna.shippingInfo` (object)

  - `paymentMethods.klarna.shippingInfo.trackingId` (string)
    Tracking number for the shipment.

  - `paymentMethods.klarna.shippingInfo.shippingMethod` (string)
    Shipping method.

  - `paymentMethods.klarna.shippingInfo.shippingCompany` (string)
    Identifier of the shipping company. The value should be a valid SHIPPING_COMPANY from the Carrier list: [https://docs.klarna.com/payments/after-payments/order-management/more-actions/klarna-carrier-partner-list/](https://docs.klarna.com/payments/after-payments/order-management/more-actions/klarna-carrier-partner-list/)

  - `paymentMethods.klarna.shippingInfo.trackingUrl` (string)
    URL where the customer can track their shipment.

  - `paymentMethods.klarna.shippingInfo.returnTrackingId` (string)
    Tracking number for the return shipment.

  - `paymentMethods.klarna.shippingInfo.returnShippingCompany` (string)
    Identifier of the shipping company. The value should be a valid SHIPPING_COMPANY from the Carrier list: [https://docs.klarna.com/payments/after-payments/order-management/more-actions/klarna-carrier-partner-list/](https://docs.klarna.com/payments/after-payments/order-management/more-actions/klarna-carrier-partner-list/)

  - `paymentMethods.klarna.shippingInfo.returnTrackingUrl` (string)
    URL where the customer can track the return shipment.

  - `paymentMethods.klarna.completeType` (string)
    With this parameter during a partial capture it is possible to reverse the remaining amount simultaneously. Possible value "YES". If the order was processed completely this parameter will cause an error, because a remaining amount of 0 cannot be reversed.

  - `paymentMethods.payPal` (object)

  - `paymentMethods.payPal.completeType` (boolean)
    Defines the completeness of capture for an open Paypal order. If sent as true, order is closed for capture. Reason: a 115% capture is permissible on the part of PayPal. If a capture reached 100%, Paygate automatically sends a request to close the payment.

  - `paymentMethods.wero` (object)

  - `paymentMethods.wero.providerTransactionId` (string)

## Request examples:

  - `Card` (unknown)

  - `Default` (unknown)

  - `Klarna` (unknown)

  - `PayPal` (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.invoiceId` (string)

  - `paymentMethods` (object)

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

  - `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.providerTransactionId` (string)
    Provider transaction ID. Returned only when Acquirer is Clearhaus.

  - `paymentMethods.card.providerApprovalCode` (string)
    Approval Code returned by acquirer.

  - `paymentMethods.klarna` (object)

  - `paymentMethods.klarna.invoiceNumber` (string)
    Invoice/booking number from Klarna. This number is needed for example for resending the E-Mail with payment and order information.

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

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

  - `paymentMethods.payPal` (object)

  - `paymentMethods.payPal.providerResponseCode` (string)
    Error code from PayPal if agreed with Smart Collect Helpdesk.

  - `paymentMethods.payPal.providerTransactionId` (string)
    Unique PayPal-generated Capture ID. The value is required for a refund after several partial captures.

  - `paymentMethods.wero` (object)

  - `paymentMethods.wero.providerTransactionId` (string)

  - `paymentMethods.wero.providerResponseText` (string)

  - `paymentMethods.wero.providerResponseCode` (string)

## 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)

  - `Klarna` (unknown)

  - `PayPal` (unknown)

## Response 422 examples:

  - `Card` (unknown)

  - `Klarna` (unknown)

  - `PayPal` (unknown)

