Skip to main content
Beta

Void a Payment

Any payment which is not captured yet, can be voided. Hellgate® supports both voiding an open and authorized payment.

Voiding open Payments​

This is a very simple operation, which just stops any activities in preparation for processing the payment. The preprequisite is, that the payment is in open state.

Voiding authorized Payments​

If a payment was succesfully authorized, it can be voided as well. In such cases the authorized amount will be cleared on the processor. The prerequisite is, that the payment is in authorized state. In contrast to void an open payment, this modification might fail, which could lead to a failed payment depending on the setup.

Request​

Find the API documentation for the request here.

POST /payments/{payment_id}/void

Response​

The payment will be in voiding state during handling the request. As soon as the voiding is completed, the payment will be in voided state.

Voided Payment (from authorized state)
{
  "id": "54ba1fdb-7e4e-402b-aebb-66f9d5345cf8",
  "amount": {
    "requested": 1000,
    "authorized": 1000,
    "voided": 1000
  },
  "created_at": "2023-10-10T00:00:00Z",
  "currency_code": "EUR",
  "flow": "e-commerce flow",
  "reference": "Order #12345",
  "status": "voided",
  "source": {
    "type": "card",
    "cardholder_name": "Bob Holder",
    "expiry_month": 12,
    "expiry_year": 2030,
    "masked_account_number": "424242XXXXXX4242",
    "pan_type": "FPAN"
  },
  "use_case": "ONE_OFF"
}