/orders/{orderId}/confirm

Sandbox (Testing): https://gateway.sand.us.zip.co/orders/{orderId}/confirm

Confirms the supplied authorized order and initiates the payment plan for the customer. If sync query parameter is set to true, replies synchronously with callback payload, otherwise, replies asynchronously on callback URL. Default sync value is false for asynchronous behavior.

Merchants using the Standard Checkout with the mobile SDK will allow customers to use the Zip checkout without starting an order until this API call is made by the merchant. This same feature can be leveraged for standard online checkouts as well. The payment plan for the customer will not begin until a successful callback is received by the merchant for this operation. This operation does allow merchants to add shipping/taxes after the Zip checkout for the order. This will be processed with the currency of the original order. This functionality is enabled upon request. Please work with the integration team during onboarding if this is needed in your implementation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
boolean
Body Params
string

Gets or sets the MerchantId

double

Gets or sets the Amount of the capture

double

Gets or sets the optional shipping amount associated with the order.

double

Gets or sets the optional tax amount associated with the order

string
required

Gets or sets the Merchant Reference of the capture

string

Gets or sets the url to callback with the confirm result

boolean

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

boolean

Get or sets a flag indicating whether or not to invoke this operation synchronously. Set to false by default.

Headers
string
required

Territory of the request (US)

string
required

The signature for merchant validation

Response

Language
LoadingLoading…
Response
Choose an example:
application/json