v1

latestOpenAPI 3.1.02026-07-24260142.2 KB

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.

post/charges/{chargeId}/cancel

Headers

Authorizationstring required

Bearer {{API key}}

Idempotency-Keystring required

Zip-Versionstring required

2021-08-25

Request body

charge_idstring required

Zip transaction charge ID to apply the refund.

referencestring

Unique transaction reference.

reasonstring required

Reason of the refund.

amountinteger required

Refund amount.

Response

200

amountinteger

captured_amountinteger

created_datestring

currencystring

idstring

productstring

receipt_numberinteger

refunded_amountinteger

statestring

Example response

{
  "amount": 200,
  "created_date": "2022-02-28T17:01:22.673Z",
  "currency": "USD",
  "id": "00d11005-d30f-405d-b8d5-917a8ab78ba0",
  "product": "partPay",
  "receipt_number": 220228254656,
  "state": "cancelled"
}