Skip to content

Void a payment

Last updated: 10th August 2022

After a card payment has been authorized, the payment is not complete until it has been captured. If you do not wish to capture the payment, you can void it using the void API described below.

For Visa and Mastercard payments, you can submit a void request on a partially captured payment to release the remaining funds back to the cardholder. If you don't request it, we'll automatically void the remainder and return it to the customer when the authorization expires.

The request

Use the endpoint below to void an authorized—but not yet captured—payment.

Endpoints

For the full API specification, see the API reference.

    post

    https://api.checkout.com/payments/{id}/voids

    Request example

    1
    2
    3
    4
    5
    6
    7
    {
    "reference": "ORD-5023-4E89",
    "metadata": {
    "coupon_code": "NY2018",
    "partner_id": 123989
    }
    }

    Response examples

    If you receive a 202 Void accepted response, your void request has been accepted for processing. To get the full void response, you will need to subscribe to the payment_voided webhook.

    If there was a problem with your request, you'll receive an error response such as 422 Invalid data was sent.

      1
      2
      3
      4
      5
      6
      7
      8
      9
      {
      "action_id": "act_y3oqhf46pyzuxjbcn2giaqnb44",
      "reference": "ORD-5023-4E89",
      "_links": {
      "payment": {
      "href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44"
      }
      }
      }

      If unsuccessful, you may also receive a 403 Void not allowed or 404 Payment not found error.