Creates a new checkout context and redirects to the checkout website using details from the request body.
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.
Important Notes
Example — "Success: True" Response
{
“Amount”: 400,
“Currency”: “USD”,
“MerchantId”: “44444444-4444-4444-4444-444444444444”,
“MerchantReference”: “1234-1”,
“OrderId”: “0050c1d4-d360-4bc6-9252-de1fb24d379d”,
“Success”: True,
“Territory”: US,
“Test”: False,
“Timestamp”: “2022-02-25T15:00:43.8391167Z”
}
Example — "Success: False" Response
- No callback webhook responses are provided when an order limit exceeds the maximum order limit. For example, if your Zip merchant account has a maximum order limit of $1,500, but a request is made for $2,000, there will be an error message displayed in the Zip checkout flow:
“There was a problem starting your order. Your requested order amount of $2,000.00 was more than [merchant]'s supported maximum order amount of $1,500.00."