Order Management

Once a customer has completed their checkout experience with Zip, there are still several ways a partner may need to interact with Zip for the purposes of order management.

Below are the flows associated with these features, should you with to implement them within your backend.

Please note that this is NOT a requirement but is recommended

Refunds

The backoffice user accesses the order list screen in the backoffice system
Orders that are in an Approved state should have a refund option displayed alongside them
Orders that are in a Authorised state should have a void/capture option displayed alongside them (auth flow)
If the refund option is clicked, the user is asked to confirm that they want to refund the order, including the amount to refund alongside a unique refund reference. Partial refunds are supported by the API. If the user confirms – then the /order/{id}/refund API method must be called, and on success – the screen refreshed with the order status updated to Refunded (or similar)

Capture and Void

This section covers the merchant being able to manually capture or void authorised transactions where payment method is auth for the integration

The backoffice user accesses the order list screen in the backoffice system
Orders that are in an Authorised state (because /order was called and fulfilled with order/acknowledge called as a follow up) will have two options alongside each of them – Capture and Void
If the capture option is clicked, the user is asked to confirm that they want to capture the order. Partial captures are not supported by the API (However, this is allowed with the proper scope enabled). If the user confirms – then the /order/{id}/capture API method must be called, and on success – the screen refreshed with the order status updated to Processing (or similar)
If the void option is clicked, the user is asked to confirm that they want to cancel the order. Partial cancellations are supported by the API. If the user confirms, then the /order/{id}/void API method must be called, and on success – the screen refreshed with the order status updated to Cancelled or similar (if full amount is voided)