Custom integrations should be built to understand the context in which they are operating. During development and testing, all configuration parameters will be specific to the Sandbox environment. This includes the Client ID, Client Secret, and Audience used in the Authorization Endpoint and the base Zip API Endpoint for all Merchant API Requests.

Once a custom integration is fully developed and tested, Zip will issue a new set of Production credentials to be used when the integration goes live.

📘

US Production: https://api.us.zip.co/
US Sandbox (Test): https://api.sand.us.zip.co/

CA Production: https://api.ca.zip.co
CA Sandbox (Test): https://api.sand.ca.zip.co/

Order Creation
Creates an Order that is used to initiate the Zip payment flow.

Production Endpoint
POST https://api.us.zip.co/order

Staging Endpoint
POST https://api.sand.us.zip.co/order

---

Get Order

Production Endpoint
GET https://api.us.zip.co/order/{orderId}

Sandbox Endpoint
GET https://api.sand.us.zip.co/order/{orderId}

---

Get Configuration
This endpoint retrieves payment configuration settings that define the valid Order min/max ranges for use with Zip.

Production Endpoint
POST https://api.us.zip.co/configuration

Sandbox Endpoint
POST https://api.sand.us.zip.co/configuration

---

Refund Order
This endpoint issues a refund against an existing 'Approved' Zip Order ID.

Requests to this endpoint are idempotent if a unique requestId is provided.

Production Endpoint
POST https://api.us.zip.co/order/[orderId]/refund

Sandbox Endpoint
POST https://api.sand.us.zip.co/order/{orderId}/refund

---

Capture Order
This endpoint issues a capture against an existing 'Approved' Zip Order ID for pay-on-ship/DFC merchants.

Requests to this endpoint are idempotent if a unique merchantReference is provided.

Production Endpoint
POST https://api.us.zip.co/order/[orderId]/capture

Sandbox Endpoint
POST https://api.sand.us.zip.co/order/{orderId}/capture

---

Void Order
This endpoint issues a void against an existing 'Approved' Zip Order ID for pay-on-ship/DFC merchants.

Requests to this endpoint are idempotent if a unique merchantReference is provided.

Production Endpoint
POST https://api.us.zip.co/order/[orderId]/void

Sandbox Endpoint
POST https://api.sand.us.zip.co/order/{orderId}/void