Creates a new checkout context and redirects to the checkout website using details from the query string parameters.

get

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

OrderId

uuid

Gets or sets the unique ID to use for order creation

MerchantId

uuid

Gets or sets the merchant Id.

MerchantReference

string

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

Gets or sets the status callback url.

RedirectCancelUrl

string

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

RedirectConfirmUrl

string

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

Metadata

object

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

enum

Gets or sets the type of the checkout. Defaults to Standard.
Can only be set internally.

Allowed:

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.

MerchantFeeForPaymentPlan

double

Gets or sets the fee added to the order for merchantFeeForPaymentPlan

CheckoutFlow

string

enum

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

Allowed:

BrandName

string

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

Expiration

int64

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

Headers

QP-Territory

string

enum

required

Defaults to US

Territory of the request

Allowed:

Response

302

Redirect