v1

latestOpenAPI 3.1.02026-07-24260142.2 KB

/orders/authorize (for Advanced Approvals merchants)

Sandbox (Testing): https://gateway.sand.us.zip.co/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. This endpoint contains the additionalData object which is used by Zip-approved merchants that are implementing our Advanced Approvals feature.

post/orders/authorize

Headers

QP-Territorystring required

Territory of the request (US)

X-QP-Signaturestring required

The signature for merchant validation

Request body

orderIdstring

Gets or sets the unique ID to use for order creation

merchantIdstring required

Gets or sets the merchant Id

merchantReferencestring required

Gets or sets the unique merchant reference for this authorization.

orderobject

Encapsulates an order to create for a merchant

testboolean

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

captureboolean

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

callbackUrlstring required

Gets or sets the status callback url

redirectCancelUrlstring required

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

redirectConfirmUrlstring required

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

metadataobject

Gets or sets optional metadata attached to the checkout

checkoutFlowstring

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

brandNamestring

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