Void

Sandbox (Testing): https://global-api.sand.au.edge.zip.co/merchant/charges/{chargeId}/cancel

Once the Charge has been Authorized, if for some reason the goods cannot be provided to the customer, the charge will need to be voided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

/charges/{chargeId}/cancel

Useful Notes

  • A void will free up any amount remaining in authorized status.
    • It is possible to void payments that have been partially captured. In this case only the authorized amount will be cancelled.
    • Captured amounts can only be refunded, not canceled.

Example Request

{
  "reference": "213123131313",
}
Body Params
string
required

Zip transaction charge ID to apply the refund.

string

Unique transaction reference.

string
required

Reason of the refund.

int32
required

Refund amount.

Headers
string
required

Bearer {{API key}}

string
required
string
required

2021-08-25

Response

Language
LoadingLoading…
Response
Choose an example:
application/json