/orders/authorize

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.

Body Params
string

Gets or sets the unique ID to use for order creation

string
required

Gets or sets the merchant Id

string
required

Gets or sets the unique merchant reference for this authorization.

order
object

Encapsulates an order to create for a merchant

boolean

Gets or sets a value indicating whether this is a test order

boolean

Gets or sets a value indicating whether this order should be immediately captured

string
required

Gets or sets the status callback url

string
required

Gets or sets the url that the user will be redirected to after they have completed the checkout.

string
required

Gets or sets the url that the user will be redirected to if they cancel the checkout

double

Gets or sets the fee added to the order for merchantFeeForPaymentPlan

string

Gets or sets the type of the checkout; defaults to Standard; can only be set internally

string

Gets or sets the brand name of the merchant for this order

Headers
string
required

Territory of the request (US, CA, MX)

string
required

The signature for merchant validation

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json