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.

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Path Params

orderId

uuid

required

Query Params

sync

boolean

Body Params

Used to confirm a previously authorized order and start the payment plan.

orderId

uuid

Gets or sets the Id of the Order.

merchantId

uuid

Gets or sets the MerchantId.

amount

double | null

Gets or sets an optional final amount, including tax and shipping, of the order to be confirmed.
If not supplied, the original order amount will be used.

shippingAmount

double | null

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

taxAmount

double | null

Gets or sets? the optional tax amount associated with the order.

merchantReference

string | null

Gets or sets the Merchant Reference of the confirmation.

callbackUrl

string | null

Gets or sets the url to callback with the confirm result.

test

boolean

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

metadata

object | null

Gets or sets optional metadata associated with this confirmation.

isSync

boolean

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

Headers

QP-Territory

string

enum

required

Defaults to US

Territory of the request

Allowed:

200Success