v1

latestOpenAPI 3.1.02026-07-24260142.2 KB

Refund

Sandbox (Testing): https://global-api.sand.au.edge.zip.co/merchant/refunds

Once a charge has been captured, if a customer wishes to return an item you will need to create a refund.

post/refunds

Headers

Authorizationstring required

Bearer {{API key}}

Idempotency-Keystring required

[RandomString]

Zip-Versionstring date 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.

amountstring required

Refund amount.

Response

200

amountinteger

charge_idstring

createdstring

idstring

reasonstring

metadataobject

Example response

{
  "amount": 100,
  "charge_id": "us-eaa26ff3-eba9-4598-a493-86c263b5a239",
  "created": "2022-02-28T16:58:31.82Z",
  "id": "us-18ff0020-468e-49e4-9382-e5c4887ec2a9",
  "reason": "Unwanted item"
}