Skip to main content

Void a pre-authorization

This method allows you to void a pre-authorized payment so the customer is not charged the payment.

Note: If the operation is successfully processed, it will update the status of the payment from AUTHORIZED to VOIDED.

  • URL syntax: /api/v2/merchant/payment/{payment_id}/void
  • Method: POST

URL parameter​

NameTypeMandatoryDescription
payment_idintYThe reference id of the payment to be voided.

Example request​

/api/v2/merchant/payment/123/void

Response parameters​

The response in this case is a Payment object.

Example response​

{
  "class": "payment",
  "id": 246804,
  "reference": "65ea37c5bc190",
  "amount": 10000,
  "currency": "EUR",
  "status": "VOIDED",
  "preauth_expiration_date": null,
  "action_url": null,
  "flow": "API",
  "processing_time": 1709848523,
  "source": 2544,
  "contract": "SysPay (8737476)",
  "descriptor": "Test Contract",
  "extra": null,
  "description": null,
  "account_id": 23918,
  "merchant_id": 2744,
  "merchant_login": "23918001",
  "settlement_date": null,
  "failure_category": null,
  "chip_and_pin_status": null,
  "capture_date": null,
  "token": {
    "class": "token",
    "id": "83377",
    "status": "ACTIVE",
    "action_url": null,
    "booking_id": "65ea33bc7446e",
    "check_in_date": "2024-03-30",
    "check_out_date": "2024-04-06",
    "booking_details": {
      "class": "booking_details",
      "type": "HOTEL",
      "booking_id": "65ea33bc7446e",
      "check_in_date": "2024-03-30",
      "check_out_date": "2024-04-06",
      "total_booking_amount": "100000",
      "booking_currency": "EUR"
    },
    "creation_date": "1709847486",
    "expiration_date": "1712439484",
    "description": "Booking 65ea33bc7446e from 2024-03-30 to 2024-04-06.",
    "extra": "Array",
    "customer": {
      "class": "customer",
      "email": "john.doe+65ea33bc72e00@gmail.com",
      "language": "en",
      "firstname": "John",
      "lastname": "Doe",
      "billing_address": {
        "class": "billing_address",
        "address1": "55 rue du Faubourg Saint-Honoré",
        "address2": null,
        "address3": null,
        "city": "Paris",
        "country": "FR",
        "postal_code": "75008"
      }
    },
    "payment_method": {
      "class": "payment_method",
      "type": "CREDITCARD",
      "validation_status": "NOT_VALIDATED",
      "validation_date": null,
      "invalid_reason": null,
      "display": "4491-70xx-xxxx-4007",
      "details": {
        "class": "payment_method_details",
        "fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
        "holder": "Card Holder Name",
        "scheme": null,
        "exp_month": "01",
        "exp_year": "2025"
      }
    },
    "moto_instance_id": null,
    "mandate": {
      "class": "mandate",
      "status": "ACTIVE",
      "currency": "EUR",
      "end_reason": null,
      "start_date": 1709847486,
      "end_date": null
    },
    "payment": null
  },
  "customer": {
    "class": "customer",
    "email": "john.doe+65ea33bc72e00@gmail.com",
    "language": "en",
    "firstname": null,
    "lastname": null,
    "billing_address": {
      "class": "billing_address",
      "address1": "55 rue du Faubourg Saint-Honoré",
      "address2": null,
      "address3": null,
      "city": "Paris",
      "country": "FR",
      "postal_code": "75008"
    }
  },
  "payment_method": {
    "class": "payment_method",
    "type": "CREDITCARD",
    "validation_status": "NOT_VALIDATED",
    "validation_date": null,
    "invalid_reason": null,
    "display": "4491-70xx-xxxx-4007",
    "details": {
      "class": "payment_method_details",
      "fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
      "holder": "Card Holder Name",
      "scheme": null,
      "exp_month": "01",
      "exp_year": "2025"
    }
  },
  "processor_reference": null,
  "qr_code": null
}