Authorize an Order
Authorize an Order
Sent from the user's browser via a form POST, will start a checkout session within Zip. It will automatically redirect the user to our Zip checkout. You need to ensure you provide your merchant ID, merchant reference (the unique ID you use for the order in your system), confirm/cancel URLs, and the order amount. The order amount should include all shipping, tax, and discount charges. You do not need to provide the order ID as that will be generated for you. Passing as much customer information as possible will improve the user experience by pre-filling data fields and improving conversion. Required fields are:
- merchantId - Your identifier provided by Zip
- merchantReference - Your unique order identifier for this order in your system
- callbackUrl - A URL that will receive the webhook request about the result of this operation
- amount - The total amount of the order, including cart value, shipping, tax, and all fees
- redirectCancelUrl - Where the user should go upon abandoning their cart
- redirectConfirmUrl - Where the user should go upon order completion (will include the aforementioned query parameters)
Example:
Request URL: https://gateway.us.zip.co/orders/authorize
POST Body:
{
"merchantId": "44444444-4444-4444-4444-444444444444",
"merchantReference": "ref",
"order": {
"currency": "USD",
"amount": 123.45,
},
"test": true,
"capture": true,
"redirectCancelUrl": "https://www.bing.com",
"redirectConfirmUrl": "https://www.google.com",
"callbackUrl": "https://api.merchant.com"
}
Authorize an Order (GET)
Same as the above endpoint but data is passed as query string parameters with a GET request.
Example:
Updated over 2 years ago