Void

Definition

Void is the process of canceling a payment authorization before the capture occurs.
It prevents the transfer of funds from the customer’s account, effectively terminating the transaction flow.

A void is only possible after a successful authorization and before capture. Once the payment is captured, a refund must be used instead. A void can be total (all authorized funds) or partial (a portion of the authorized amount).

info

Void operations are common in pre-authorization flows, such as hotel bookings or car rentals, where the merchant may choose to cancel the transaction before finalizing it.

Steps in Void

1️⃣ A payment authorization is initially approved.
2️⃣ The merchant sends a void request to cancel the authorization.
3️⃣ The issuer releases the reserved funds.
4️⃣ No funds are captured or transferred.

Full Void request

Endpoint

• Endpoint: /payment/v2/payments/{payment_id}/voids
• Method: POST
• See Void API

Request Data

Request body for a full void operation.

{
  "amount": 10,
  "order": {
    "shipments": [
      {
        "net_amount": 4299,
        "item_lines": [
          {
            "type": "PHYSICAL",
            "sku_reference": "SKU_01",
            "name": "My awesome product",
            "brand": "My awesome brand",
            "unit_gross_price": 1099,
            "net_amount": 4299,
            "discount_amount": 0,
            "quantity": 4,
            "tax_amount": 399,
            "tax_rate": 20,
            "seller_reference": "SELLER_01",
            "seller_name": "My awesome seller",
            "is_marketplace_seller": true
          }
        ]
      }
    ]
  },
  "priority": [
    {
      "partner": "string",
      "method": "string"
    }
  ],
  "merchant_reference": "CAP#1223445"
}

Full Void Response

Response Data

Response body for a full void operation.

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "overview": {
    "consumed": "NOT",
    "captured": "NOT",
    "voided": "NOT",
    "refunded": "NOT"
  },
  "client_session_id": "083e320e-e2e2-4a94-b5e1-abc028b960ab",
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  "version": 3,
  "order_reference": "order_01",
  "amount": 4299,
  "currency": "EUR",
  "capture_mode": "MANUAL",
  "captures": [
    {
      "id": "e3a6516b-0ec4-4a5b-92b0-7bb9693e82c1",
      "amount": 4299,
      "created_at": "2020-08-25T10:42:59.123+02:00",
      "updated_at": "2020-08-25T10:42:59.123+02:00",
      "triggered_by": "MERCHANT",
      "merchant_reference": "CAP#1223445",
      "status": "SUCCESS",
      "partner_transactions": [
        {
          "id": "e3a6516b-0ec4-4a5b-92b0-7bb9693e82c1",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "amount": 4299,
          "partner": "ingenico",
          "method": "creditcard",
          "partner_reference": "AE0002ZCF7652QFF",
          "partner_status": "000.000.000",
          "partner_status_description": "Transaction succeeded",
          "partner_token": "f8a333e9-cdc2-45d1-b9e5-dba95e00fa95",
          "status": "SUCCESS",
          "remaining_amount": 4299
        }
      ],
      "order": {
        "shipments": [
          {
            "net_amount": 4299,
            "item_lines": [
              {
                "type": "PHYSICAL",
                "sku_reference": "SKU_01",
                "name": "My awesome product",
                "brand": "My awesome brand",
                "unit_gross_price": 1099,
                "net_amount": 4299,
                "discount_amount": 0,
                "quantity": 4,
                "tax_amount": 399,
                "tax_rate": 20,
                "seller_reference": "SELLER_01",
                "seller_name": "My awesome seller",
                "is_marketplace_seller": true
              }
            ]
          }
        ]
      }
    }
  ],
  "voids": [
    {
      "id": "e3a6516b-0ec4-4a5b-92b0-7bb9693e82c1",
      "amount": 4299,
      "created_at": "2020-08-25T10:42:59.123+02:00",
      "updated_at": "2020-08-25T10:42:59.123+02:00",
      "triggered_by": "MERCHANT",
      "merchant_reference": "CAP#1223445",
      "status": "SUCCESS",
      "partner_transactions": [
        {
          "id": "e3a6516b-0ec4-4a5b-92b0-7bb9693e82c1",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "amount": 4299,
          "partner": "ingenico",
          "method": "creditcard",
          "partner_reference": "AE0002ZCF7652QFF",
          "partner_status": "000.000.000",
          "partner_status_description": "Transaction succeeded",
          "partner_token": "f8a333e9-cdc2-45d1-b9e5-dba95e00fa95",
          "status": "SUCCESS",
          "remaining_amount": 4299
        }
      ],
      "order": {
        "shipments": [
          {
            "net_amount": 4299,
            "item_lines": [
              {
                "type": "PHYSICAL",
                "sku_reference": "SKU_01",
                "name": "My awesome product",
                "brand": "My awesome brand",
                "unit_gross_price": 1099,
                "net_amount": 4299,
                "discount_amount": 0,
                "quantity": 4,
                "tax_amount": 399,
                "tax_rate": 20,
                "seller_reference": "SELLER_01",
                "seller_name": "My awesome seller",
                "is_marketplace_seller": true
              }
            ]
          }
        ]
      }
    }
  ],
  "refunds": [
    {
      "id": "e3a6516b-0ec4-4a5b-92b0-7bb9693e82c1",
      "amount": 4299,
      "created_at": "2020-08-25T10:42:59.123+02:00",
      "updated_at": "2020-08-25T10:42:59.123+02:00",
      "triggered_by": "MERCHANT",
      "merchant_reference": "CAP#1223445",
      "status": "SUCCESS",
      "partner_transactions": [
        {
          "id": "e3a6516b-0ec4-4a5b-92b0-7bb9693e82c1",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "amount": 4299,
          "partner": "ingenico",
          "method": "creditcard",
          "partner_reference": "AE0002ZCF7652QFF",
          "partner_status": "000.000.000",
          "partner_status_description": "Transaction succeeded",
          "partner_token": "f8a333e9-cdc2-45d1-b9e5-dba95e00fa95",
          "status": "SUCCESS",
          "remaining_amount": 4299
        }
      ],
      "order": {
        "shipments": [
          {
            "net_amount": 4299,
            "item_lines": [
              {
                "type": "PHYSICAL",
                "sku_reference": "SKU_01",
                "name": "My awesome product",
                "brand": "My awesome brand",
                "unit_gross_price": 1099,
                "net_amount": 4299,
                "discount_amount": 0,
                "quantity": 4,
                "tax_amount": 399,
                "tax_rate": 20,
                "seller_reference": "SELLER_01",
                "seller_name": "My awesome seller",
                "is_marketplace_seller": true
              }
            ]
          }
        ]
      }
    }
  ],
  "authorization": {
    "updated_at": "2019-08-24T14:15:22Z",
    "status": "AUTHORIZED",
    "partner_transactions": [
      {
        "id": "e3a6516b-0ec4-4a5b-92b0-7bb9693e82c1",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "amount": 4299,
        "partner": "ingenico",
        "method": "creditcard",
        "partner_reference": "AE0002ZCF7652QFF",
        "partner_status": "000.000.000",
        "partner_status_description": "Transaction succeeded",
        "partner_token": "f8a333e9-cdc2-45d1-b9e5-dba95e00fa95",
        "status": "AUTHORIZED",
        "card": {
          "bin": "513842",
          "last_four_digits": "1234",
          "holder_name": "John Doe",
          "expiry_month": "01",
          "expiry_year": "24",
          "selected_network": "VISA",
          "three_ds": {
            "eci": "01",
            "version": "2.2.0",
            "flow": "CHALLENGE",
            "ds_transaction_id": "f8a333e9-cdc2-45d1-b9e5-dba95e00fa95",
            "acs_transaction_id": "f8a333e9-cdc2-45d1-b9e5-dba95e00fa95"
          }
        },
        "remaining_amount": 4299
      }
    ]
  },
  "amounts": {
    "total_authorized": 4299,
    "total_voided": 299,
    "available_to_void": 1000,
    "total_captured": 3000,
    "available_to_capture": 1000,
    "total_refunded": 0,
    "available_to_refund": 3000
  },
  "links": {
    "self": {
      "href": "/v2/client-sessions/9a14962c-bdcf-49d1-8673-e75dfb48013f",
      "method": "GET"
    },
    "capture": {
      "href": "/v2/payments/9a14962c-bdcf-49d1-8673-e75dfb48013f/captures",
      "method": "POST"
    },
    "refund": {
      "href": "/v2/payments/9a14962c-bdcf-49d1-8673-e75dfb48013f/refunds",
      "method": "POST"
    },
    "void": {
      "href": "/v2/payments/9a14962c-bdcf-49d1-8673-e75dfb48013f/voids",
      "method": "POST"
    }
  },
  "split": [
    {
      "partner": "ingenico",
      "method": "creditcard",
      "amount": 4299,
      "parent_partner_transaction_id": "1a2b3c4d-1a2b-abcd-1234-123456789abc",
      "parent_payment_id": "9399c938-80e1-11ef-9de7-327d4a6ae82c",
      "parent_partner_token": "64837-39372-32188",
      "parent_partner_reference": 123456789
    }
  ],
  "webhook": {
    "url": "https://www.example.org/payment-hook?order_id=123456789",
    "headers": [
      {
        "name": "x-order-id",
        "values": [
          123456789
        ]
      }
    ]
  }
}

Additional Notes

• A void is typically used when the merchant wants to cancel the transaction before any capture.
• After the authorization window expires (usually 7 days), void is no longer possible—a refund may be required instead.