/orders/authorize

get

https://gateway.us.zip.co/orders/authorize

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.

The same as the first /orders/authorize endpoint but data is passed as query string parameters with a GET request.

Query Params

orderId

string

Gets or sets the unique ID to use for order creation

merchantId

string

required

Gets or sets the merchant Id

merchantReference

string

required

Gets or sets the unique merchant reference for this authorization.

Order.FirstName

string

Gets or sets the customer's first name

Order.LastName

string

Gets or sets the customer's last name

Order.Email

string

Gets or sets the customer's email address

Order.Phone

string

Gets or sets the customer's phone number

Order.ShippingAddress.Line1

string

Gets or sets the first address line

Order.ShippingAddress.Line2

string

Gets or sets the second address line

Order.ShippingAddress.City

string

Gets or sets the city

Order.ShippingAddress.State

string

Gets or sets the state or province

Order.ShippingAddress.PostalCode

string

Gets or sets the postal code

Order.ShippingAddress.Country

string

Gets or sets the country

Order.BillingAddress.Line1

string

Gets or sets the first address line

Order.BillingAddress.Line2

string

Gets or sets the second address line

Order.BillingAddress.City

string

Gets or sets the city

Order.BillingAddress.State

string

Gets or sets the state or province

Order.BillingAddress.PostalCode

string

Gets or sets the postal code

Order.BillingAddress.Country

string

Gets or sets the country

Order.Currency

string

Gets or sets the currency the order amount is in (defaults to TerritorySettings)

Order.Amount

double

Gets or sets the order amount. This includes the tax and shipping amounts.

Order.TaxAmount

double

Gets or sets the optional tax amount

Order.ShippingAmount

double

Gets or sets the optional shipping amount

Order.LineItems

array of objects

Gets or sets the optional line items of what the user is purchasing

Order.LineItems

Order.Description

string

Gets or sets a description for the order

Order.OrderNumber

string

Gets or sets the QuadPay order number

test

boolean

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

Capture

boolean

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

CallbackUrl

string

required

Gets or sets the status callback url

RedirectCancelUrl

string

required

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

RedirectConfirmUrl

string

required

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

metadata

string

Gets or sets optional metadata attached to the checkout

origin

string

Gets or sets the origin of the order. Usually the merchant's website. Can only be set internally

GatewayHost

string

Gets or sets the gateway api host; can only be set internally

CheckoutType

string

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

RequiresCookie

boolean

Gets or sets a value indicating whether the checkout context should be set as a cookie

DeferOrderConfirmation

boolean

Gets or sets a value indicating whether or not to confirm the order upon customer checkout completion. If true, the merchant must make a secondary API call to confirm the order and begin the payment plan. Default is false.

CheckoutFlow

string

Gets or sets the checkout flow for this order. Default is standard

BrandName

string

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

Expiration

int32

Gets or sets a unix timestamp representing the expiration time of the checkout.

X-QP-Signature

string

The signature for merchant validation

Headers

QP-Territory

string

required

Territory of the request (US)

Response

302302