Documentation

Void Payment

Void an eligible payment recorded against an invoice. The API key user needs invoice editing and payment void permissions. QReserve keeps the record, marks it unsuccessful and voided, and updates the invoice totals.

POST /invoices/{invoice_id}/delete_payment/{payment_record_id}

Path Parameters

Parameter Type Required Description
invoice_id string Yes QReserve invoice ID.
payment_record_id string Yes Value of invoice_payment_record_id from the payment record.

Example

Send an empty JSON object.

curl -X POST 'https://api.qreserve.com/invoices/INVOICE_ID/delete_payment/PAYMENT_RECORD_ID' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response

data contains the updated payment record. The example is abbreviated. The payment must belong to the current invoice. Shift4 payments require the processorโ€™s refund workflow and are rejected by this endpoint.

{
  "status": "success",
  "data": {
    "invoice_payment_record_id": "PAYMENT_RECORD_ID",
    "amount": 2500,
    "amount_dec": 25,
    "currency_code": "CAD",
    "success": false,
    "payment_source": "manual",
    "payment_method": "Cheque (VOIDED)",
    "received_date": "2026-10-15",
    "invoice": {
      "invoice_id": "INVOICE_ID"
    }
  }
}

See the Invoices API overview for shared IDs and permissions.