Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
Transactions

transactions_id_capture_post

Captures a transaction that was created with the Checkout endpoint with a capture_now value of false.

Capture Instabank transaction

Note that items is required when capturing a transaction with payment_product=instabank. The items must include the lines to Capture, with line_id, quantity and amount.

scopes:

  • admin:checkout
  • write:checkout
post/accounts/{aid}/payments/transactions/{id}/capture

Path parameters

idstring checkout-id required

The ID of the transaction

Query parameters

includesstring[]

Include aditional data in the returned data that are by default excluded from the transaction details.

  • events.request_headers Include the event headers stored for each event deprecated
  • initiating_system_request_headers Include the request headers from the initating system deprecated

From 2023-09, events.request_headers and initiating_system_request_headers will be included by default

Headers

Dintero-System-Namestring

The name of the ecommerce solution

Example: woocommerce

Dintero-System-Versionstring

The version number of the ecommerce solution

Example: 5.4

Dintero-System-Plugin-Namestring

The name of the ecommerce plugin

Example: Dintero.Checkout.WooCommerce

Dintero-System-Plugin-Versionstring

The version number of the ecommerce plugin

Example: 2.3.4

Request body

metadataobject

Additional metadata about the resource

All metadata keys must be prefixed with ext_ and the length if key/value pair is 128/256 characters

amountinteger required

The amount to be captured

capture_referencestring

A reference specified by the merchant to identify the transaction

final_captureboolean

Indicates whether the capture is final. If true additional captures on the transaction are not allowed and the authorization on any remaining uncaptured amount will be voided. Only applies to transactions where the payment_product is dintero_psp.

Example request

{
  "metadata": {
    "ext_system_x_id": "XAB1239",
    "ext_number_x": "1921",
    "ext_original_currency": "USD",
    "ext_original_amount": "3007",
    "ext_conversion_rate_ppm": "997258",
    "ext_conversion_timestamp": "2025-09-09T08:12:30Z"
  },
  "amount": 29990,
  "items": [
    {
      "id": "item_01",
      "groups": [
        {
          "id": "B234",
          "name": "Stol"
        }
      ],
      "line_id": "1",
      "description": "Stablestol",
      "quantity": 1,
      "amount": 29990,
      "vat_amount": 400,
      "vat": 20,
      "splits": [
        {
          "payout_destination_id": "seller-1",
          "amount": 29700
        }
      ],
      "emd": {
        "event": [
          {
            "event_name": "Michael Jackson",
            "event_company": "Diamond Events",
            "genre_of_event": "Pop",
            "arena_name": "Oslo Spektrum",
            "arena_location": {
              "street_address": "Sonja Henies plass 2",
              "postal_code": "0185",
              "city": "Oslo",
              "country": "NO"
            },
            "start_time": "2023-08-16T15:00:00Z",
            "end_time": "2023-08-16T16:00:00Z",
            "access_controlled_venue": true,
            "ticket_delivery_method": "email",
            "ticket_delivery_recipient": "recipient@mail.com",
            "affiliate_name": "Klarna affiliate"
          }
        ],
        "subscription": {
          "subscription": {
            "subscription_name": "Contact lenses",
            "start_time": "2023-08-16T15:00:00Z",
            "end_time": "2023-09-16T15:00:00Z",
            "auto_renewal_of_subscription": true,
            "affiliate_name": "Klarna affiliate"
          },
          "customer_account_info": {
            "unique_account_identifier": "Adam Adamsson",
            "account_registration_date": "2023-08-16T15:00:00Z",
            "account_last_modified": "2023-10-16T15:00:00Z"
          }
        },
        "travel": {
          "air_reservation_details": {
            "pnr": "VH67899",
            "itinerary": [
              {
                "departure": "OSL",
                "departure_city": "Oslo",
                "arrival": "MUC",
                "arrival_city": "Munich",
                "carrier": "LH",
                "segment_price": 200000,
                "departure_date": "2023-08-16T15:00:00Z",
                "ticket_delivery_method": "phone",
                "ticket_delivery_recipient": "97712123",
                "passenger_id": [
                  1
                ],
                "class": "First Class"
              }
            ],
            "insurance": [
              {
                "insurance_company": "Oopsie Insurance Ltd.",
                "insurance_type": "travel",
                "insurance_price": 50000
              }
            ],
            "passengers": [
              {
                "id": 1,
                "title": "mr",
                "first_name": "Paul",
                "last_name": "Lamb"
              }
            ],
            "affiliate_name": "Klarna affiliate"
          },
          "bus_reservation_details": {
            "pnr": "VH67899",
            "itinerary": [
              {
                "departure_city": "Oslo",
                "arrival_city": "Munich",
                "carrier": "Big Bus Travels Ltd.",
                "segment_price": 200000,
                "departure_date": "2023-08-16T15:00:00Z",
                "ticket_delivery_method": "phone",
                "ticket_delivery_recipient": "97712123",
                "passenger_id": [
                  1
                ],
                "class": "First Class"
              }
            ],
            "insurance": [
              {
                "insurance_company": "Oopsie Insurance Ltd.",
                "insurance_type": "travel",
                "insurance_price": 50000
              }
            ],
            "passengers": [
              {
                "id": 1,
                "title": "mr",
                "first_name": "Paul",
                "last_name": "Lamb"
              }
            ],
            "affiliate_name": "Klarna affiliate"
          },
          "train_reservation_details": {
            "pnr": "VH67899",
            "itinerary": [
              {
                "departure_city": "Oslo",
                "arrival_city": "Munich",
                "carrier": "Big Train Travels Ltd.",
                "segment_price": 200000,
                "departure_date": "2023-08-16T15:00:00Z",
                "ticket_delivery_method": "phone",
                "ticket_delivery_recipient": "97712123",
                "passenger_id": [
                  1
                ],
                "class": "First Class"
              }
            ],
            "insurance": [
              {
                "insurance_company": "Oopsie Insurance Ltd.",
                "insurance_type": "travel",
                "insurance_price": 50000
              }
            ],
            "passengers": [
              {
                "id": 1,
                "title": "mr",
                "first_name": "Paul",
                "last_name": "Lamb"
              }
            ],
            "affiliate_name": "Klarna affiliate"
          },
          "ferry_reservation_details": {
            "pnr": "VH67899",
            "itinerary": [
              {
                "departure_city": "Oslo",
                "arrival_city": "Munich",
                "carrier": "Big Ferry Travels Ltd.",
                "segment_price": 200000,
                "departure_date": "2023-08-16T15:00:00Z",
                "ticket_delivery_method": "phone",
                "ticket_delivery_recipient": "97712123",
                "passenger_id": [
                  1
                ],
                "class": "First Class"
              }
            ],
            "insurance": [
              {
                "insurance_company": "Oopsie Insurance Ltd.",
                "insurance_type": "travel",
                "insurance_price": 50000
              }
            ],
            "passengers": [
              {
                "id": 1,
                "title": "mr",
                "first_name": "Paul",
                "last_name": "Lamb"
              }
            ],
            "affiliate_name": "Klarna affiliate"
          },
          "hotel_reservation_details": {
            "pnr": "VH67899",
            "itinerary": [
              {
                "hotel_name": "Premium Hotel",
                "address": {
                  "street_address": "Karl Johans gt. 31",
                  "postal_code": "0159",
                  "city": "Oslo",
                  "country": "NO"
                },
                "start_time": "2023-08-16T15:00:00Z",
                "end_time": "2023-08-20T15:00:00Z",
                "number_of_rooms": 2,
                "passenger_id": [
                  1
                ],
                "ticket_delivery_method": "phone",
                "ticket_delivery_recipient": "97712123",
                "hotel_price": 200000,
                "class": "First Class"
              }
            ],
            "insurance": [
              {
                "insurance_company": "Oopsie Insurance Ltd.",
                "insurance_type": "travel",
                "insurance_price": 50000
              }
            ],
            "passengers": [
              {
                "id": 1,
                "title": "mr",
                "first_name": "Paul",
                "last_name": "Lamb"
              }
            ],
            "affiliate_name": "Klarna affiliate"
          },
          "car_rental_reservation_details": {
            "pnr": "VH67899",
            "itinerary": [
              {
                "rental_company": "Premium Cars",
                "drivers_id": [
                  1
                ],
                "pick_up_location": {
                  "street_address": "Karl Johans gt. 31",
                  "postal_code": "0159",
                  "city": "Oslo",
                  "country": "NO"
                },
                "drop_off_location": {
                  "street_address": "Karl Johans gt. 31",
                  "postal_code": "0159",
                  "city": "Oslo",
                  "country": "NO"
                },
                "start_time": "2023-08-16T15:00:00Z",
                "end_time": "2023-08-20T15:00:00Z",
                "car_price": 500000,
                "class": "Premium Cars Premium Class"
              }
            ],
            "insurance": [
              {
                "insurance_company": "Oopsie Insurance Ltd.",
                "insurance_type": "travel",
                "insurance_price": 50000
              }
            ],
            "drivers": [
              {
                "id": 1,
                "title": "mr",
                "first_name": "Paul",
                "last_name": "Lamb"
              }
            ],
            "affiliate_name": "Klarna affiliate"
          }
        },
        "marketplace_order": {
          "seller_info": {
            "unique_account_identifier_seller": {
              "phone_number": "97712123"
            },
            "sub_merchant_id": "Marketbrick Ltd.",
            "product_category": "Phones",
            "product_name": "iPhone 14 Pro Max",
            "account_registration_date": "2023-08-16T15:00:00Z",
            "account_last_modified": {
              "password": "2023-08-17T15:00:00Z",
              "email": "2023-08-17T15:00:00Z",
              "listing": "2023-08-17T15:00:00Z",
              "login": "2023-08-17T15:00:00Z",
              "address": "2023-08-17T15:00:00Z"
            },
            "seller_rating": 5,
            "number_of_trades": 23,
            "volume_of_trades": 230
          },
          "winner_info": {
            "unique_account_identifier_winner": {
              "phone_number": "97712123"
            },
            "account_registration_date": "2023-08-16T15:00:00Z",
            "account_last_modified": {
              "password": "2023-08-17T15:00:00Z",
              "email": "2023-08-17T15:00:00Z",
              "listing": "2023-08-17T15:00:00Z",
              "login": "2023-08-17T15:00:00Z",
              "address": "2023-08-17T15:00:00Z"
            },
            "number_of_trades": 23,
            "volume_of_trades": 230
          }
        }
      },
      "store": {
        "id": "sc029",
        "name": "SC Oslo",
        "business_name": "SC Oslo AS",
        "address": {
          "address_line": "Sommerkroveien 34",
          "address_line_2": "PB 123",
          "postal_code": "0349",
          "postal_place": "Oslo",
          "country": "NO"
        },
        "chain": "SuperChain",
        "email": "contact@superchain.com",
        "gln": "5790001398644",
        "organization_number": "123456789MVA",
        "phone_number": "+4738260107",
        "mcc": "5814",
        "bax": "102603",
        "terminal_id": "T0292",
        "payout_destination_id": "seller-1"
      },
      "discount_lines": [
        {
          "amount": 4400,
          "percentage": 44,
          "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
          "line_id": 1
        }
      ]
    }
  ]
}

Response

Capture created

idstring

An ID that uniquely identifies the resource

created_atstring date-time

When the transaction was created

payment_product'bambora' | 'collector' | 'dintero' | 'dintero_psp' | 'instabank' | 'klarna' | 'netaxept' | 'payex' | 'santander' | 'swish' | 'vipps' | 'kravia' | 'two' | 'seitatech' required

The payment product corresponding to this transaction

payment_product_type'bambora.applepay' | 'bambora.creditcard' | 'bambora.googlepay' | 'bambora.mobilepay' | 'bambora.vipps' | 'collector.invoice' | 'collector.invoice_b2b' | 'collector.invoice_b2b_preapproved' | 'collector.installment' | 'dintero.zero' | 'dintero.wallets' | 'dintero.external' | 'dintero_psp.creditcard' | 'dintero_psp.vipps' | 'dintero_psp.googlepay' | 'dintero_psp.applepay' | 'dintero_psp.clicktopay' | 'instabank.finance' | 'instabank.invoice' | 'instabank.installment' | 'instabank.postponement' | 'klarna.klarna' | 'klarna.billie' | 'kravia.invoice_b2b' | 'kravia.invoice_b2b_grouped' | 'kravia.invoice_b2c' | 'two.invoice_b2b' | 'netaxept.creditcard' | 'payex.creditcard' | 'payex.mobilepay' | 'payex.swish' | 'payex.vipps' | 'payex.applepay' | 'payex.clicktopay' | 'payex.googlepay' | 'santander.debit_account' | 'seitatech.in_person' | 'swish.swish' | 'vipps' required

The payment product type corresponding to this transaction

amountinteger required

Non-negative, minor units. Total amount of the transaction

currencystring iso4217-code required

ISO 4217 transaction currency

payout_destination_idstring

An id that identifies the seller, value will be included in the settlement reports

merchant_referencestring

A reference specified by the merchant to identify the transaction

channel'ecommerce' | 'in_app' | 'in_store'

The channel for the transaction

platform_type'aggregator' | 'marketplace'

Type of platform the merchant is.

merchant_reference_2string

A reference specified by the merchant to identify the transaction, can be updated after the transaction has been created

dynamic_descriptorstring

A short reference / descriptor that will show up on the customers bank statement

payment_operation'unscheduled_purchase' | 'recurring_purchase' | 'generate_payment_token'

Initiated by the merchant or used to generate a token

settlement_status'NOT_SETTLED' | 'PENDING_SETTLEMENT' | 'PARTIALLY_SETTLED' | 'SETTLED'

Overall settlement status after the events

customer_ipstring

The IP address of the customer

user_agentstring

The full user agent string of the device the customer used to submit the transaction

status'INITIATED' | 'AUTHORIZED' | 'AUTHORIZATION_VOIDED' | 'CAPTURED' | 'PARTIALLY_CAPTURED' | 'PARTIALLY_CAPTURED_REFUNDED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'DECLINED' | 'FAILED' | 'UNKNOWN' | 'ON_HOLD'

The current status of the transaction

session_idstring

The session id for the transaction

updated_atstring date-time

When the transaction was last modified.