Void Invoice

Endpoints: /v1/invoices/{invoice_id}
HTTP Method: PATCH
Headers:

Production: https://api.midtrans.com/v1/invoices/{invoice_id}/void

Sandbox: https://api.sandbox.midtrans.com/v1/invoices/{invoice_id}/void

KeyDescription
AuthorizationBasic Base64Encode(merchantServerKey:)
📘

Eligibility

Only invoices with PENDING and OVERDUE status can be voided. For quotations, only PUBLISHED quotations can be voided.




Request Example

Without cancelAs:

curl --location --request PATCH 'https://api.midtrans.com/v1/invoices/{invoice_id}/void' \
--header 'Authorization: Basic Base64Encode(merchantServerKey:)'

With cancelAs:

curl --location --request PATCH 'https://api.midtrans.com/v1/invoices/{invoice_id}/void?cancelAs=client' \
--header 'Authorization: Basic Base64Encode(merchantServerKey:)'

Query Parameter

ParameterDescription
cancelAs
Optional

Specifies the cancellation mode used when voiding a document.
cancelAs=client will set the document status to REJECTED.

Note: Only to Quotations and cannot be used for Invoices.

Response

{
   "success": true
}
{
   "error_messages": [
       "Not Found"
   ]
}
{
   "error_messages": [
       "Invoice cannot be canceled"
   ]
}
{
   "error_messages": [
       "Internal server error"
   ]
}