Orders

Void order

Void any authorizations for the order. The customer is informed of the cancellation and that the order could not be fulfilled; any held funds are released.

post/v2/payments/{token}/void

Request

Base URL
https://integration.api.scalapay.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/scalapay/apis/scalapay-api/docs/v2/payments/:token/void/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tokenstring string required

Order token.

Headers

Idempotency-Keystring

Idempotency key used for retrying requests. Can be used for retrying failed requests.

Request body

merchantReferencestring

Merchant reference for tracking the order in your system.

Response

Order voided successfully

tokenstring required

The order token.

merchantReferencestring

The merchant reference.

voidedAtstring

The date and time when the order was voided.

Changes

No recorded changes to this operation across all 2 revisions of this API.