Orders

Delay order

Request a delayed capture for the order. The payment schedule for the customer is created; however, no funds are settled until a capture call is made. Outstanding authorizations are automatically voided once the authorization expiry time is reached.

post/v2/payments/{token}/delay

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

authorizationExpiryMillisecondsinteger required

Length of time (in milliseconds) that the authorization is valid.

merchantReferencestring

Merchant reference for tracking the order in your system.

Response

Order delayed successfully

tokenstring required

The order token.

statusstring required

The current status of the order after delay.

authorizationExpiryAtstring

The date and time when the authorization expires.

orderDetailsobject

The full order details.

Changes

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