Skip to main content

SimulateExpiryRequest

Advance one sandbox expiry clock without waiting for its timer

paymentRequestReferencestringrequired

Payment request UUID, your externalId, or the paymentLinkReference. The JSON field paymentRequestId is also accepted.

Possible values: non-empty

Example: ORDER-10045
targetstringrequired

CRYPTO_QUOTE expires a quote without settling it. PAYMENT_DEADLINE stops new attempts while retaining the closing window. PAYMENT_REQUEST runs final expiry checks; a pending payment can keep the request open.

Possible values: [CRYPTO_QUOTE, PAYMENT_DEADLINE, PAYMENT_REQUEST]

Example: CRYPTO_QUOTE
quotePaymentIdstring<uuid>

Optional for CRYPTO_QUOTE: omit to expire the latest quote for the payment request. Omit for PAYMENT_DEADLINE and PAYMENT_REQUEST.

SimulateExpiryRequest
{
  "paymentRequestReference": "ORDER-10045",
  "target": "CRYPTO_QUOTE",
  "quotePaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}