v1

latestOpenAPI 3.1.02026-07-24260142.2 KB

/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.

post/orders/{orderId}/confirm

Path parameters

orderIdstring required

Query parameters

syncboolean

Headers

QP-Territorystring required

Territory of the request (US)

X-QP-Signaturestring required

The signature for merchant validation

Request body

merchantIdstring

Gets or sets the MerchantId

amountnumber double

Gets or sets the Amount of the capture

shippingAmountnumber double

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

taxAmountnumber double

Gets or sets the optional tax amount associated with the order

merchantReferencestring required

Gets or sets the Merchant Reference of the capture

callbackUrlstring

Gets or sets the url to callback with the confirm result

testboolean

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

metadataobject

Gets or sets optional metadata associated with this capture

Response

200

timestampstring

merchantIdstring

orderIdstring

currencystring

amountinteger

merchantReferencestring

testboolean

successboolean

messagestring

operationstring

Example response

{
  "timestamp": "2021-12-01T16:45:48.160Z",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": "string",
  "merchantReference": "string",
  "test": true,
  "success": true,
  "message": "string",
  "metadata": {
    "additionalProp": "string"
  },
  "operation": "string"
}