Voids uncaptured funds for the specified order and allocates them to the payment plan to apply it to the customer. Only applicable to pay-on-ship/deferred fund capture merchants. 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

orderId

uuid

Gets or sets the Id of the Order.

merchantId

uuid

Gets or sets the MerchantId.

currency

string | null

Gets or sets the Currency of the void.

amount

double

Gets or sets the Amount of the void.

merchantReference

string | null

Gets or sets the Merchant Reference of the void.

callbackUrl

string | null

Gets or sets the url to callback with the void 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 void.

isSync

boolean

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

isAmountInCommand

boolean

Gets or sets a flag indicating whether or not the command amount is set and not defaulted. By default, the
void amount is included in the command.

Headers

QP-Territory

string

enum

required

Defaults to US

Territory of the request

Allowed:

200Success