Web checkout API

Create a Refund

Give your shoppers the option to pay with Zip on your web platform with our web checkout solution.

To process a refund you will need to make a request to the /refunds endpoint. This request is made using the charge Id returned by Zip in your /charges API call.

This API call will contain:

• Charge_id
• Reason
• Amount

The Zip API response will contain:

• Id - a unique reference for your refund
• Charge_Id - The original charge id of the refunded order
• Reason
• Amount
• Created date time

This /refunds API call should be made from your server and not directly from the client front end. Generally this is triggered from your order management system.

Charge Id

Zip require the original order charge Is to process a a refund. This will have been obtained from the initial charges API call to Zip

Here is an example of how this information can be passed:

{
    "charge_id": "au-ch_LyT7NLI6iIR0zBQllkbfsA",
}

Reason and amount

Full or partial refunds can be processed against the original order. If a customer is to return a single item from a purchase that included multiple items, only the value of the item to be refunded should be passed to Zip.

The refund reason is passed for your reference purposes if recalling the refund data from Zip at a later time.

Here is an example of how this information can be passed:

{
    "reason": "Unwanted item",
    "amount": 5
}

The full request

An example payload can be found below:

{
  "charge_id": "au-ch_LyT7NLI6iIR0zBQllkbfsA",
  "reason": "Unwanted item",
  "amount": 5
}