Skip to main content

SimulateCryptoDepositRequest

Simulate a deposit against an existing sandbox checkout crypto quote

paymentRequestReferencestringrequired

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

Possible values: non-empty

Example: ORDER-10045
quotePaymentIdstring<uuid>required

cryptoPaymentId from the checkout quote response. Use the same primary ID for every deposit in this quote round; this is not a provider quote ID.

depositIdstring<uuid>required

Client-generated UUID for one deposit. Reuse this ID and the same amount to retry or confirm that deposit; use a new ID for each split deposit.

cryptoAmountnumberrequired

Amount in the quote's cryptocurrency, not fiat. Total deposits cannot exceed the quoted cryptoQuantity.

Example: 10.25
statusstringrequired

PENDING detects a deposit without receiving funds; CONFIRMED receives funds but does not credit the wallet. A confirmed deposit never regresses on retry.

Possible values: [PENDING, CONFIRMED]

SimulateCryptoDepositRequest
{
  "paymentRequestReference": "ORDER-10045",
  "quotePaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "depositId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cryptoAmount": 10.25,
  "status": "PENDING"
}