Cancel Invoice

This endpoint enables the cancellation of an existing invoice. It requires the invoice transaction number to cancel it, preventing further payment processing.

Endpoint

POST /api/cancelInvoice

Request Headers

HeaderRequiredDescription
AuthorizationYesBearer token provided by Authentication Endpoint
AcceptYesIt must be set to application/JSON.
Content-TypeYesIt must be set to application/JSON.
{
  "Authorization": "Bearer [id_token]",
  "Accept": "application/json",
  "Content-Type": "application/json"
}

Request Body Parameters

ParameterTypeRequiredDescription
transactionNostringYesThe unique transaction number is to be canceled.

An example of the request is as follows:

{
  "transactionNo": "1707943132122"
}

Response Body

The API endpoint will return a JSON response with the following parameters:

ParameterTypeDescription
successBooleanThis field indicates whether this endpoint operation is successful or not.

Example of the response:

{
  "success": true
}