/order/{orderId}/void

Voids (uncaptured) funds of an order, and updates the customer's installment plan to adjust for the reduced order amount.

This is used when part of an order is canceled eg it was out of stock and will not be shipped.

Requests to this endpoint are idempotent if a unique merchantReference is provided.

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

The OrderId is the Zip identifier for an order. This is issued when creating an order and is also passed on the redirect confirmation URL as the 'token' parameter.

Body Params
float
required

The amount to void. Cannot exceed the remaining uncaptured funds in an order

string
required

Merchant generated unique ID for this refund request used as an idempotency key. We suggest using a GUID here.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
text/plain