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>

Optional quote ID. Omit to use the latest quote for this payment request. A retry uses the original deposit quote. The response includes the selected quotePaymentId.

depositIdstring<uuid>required

Client-generated UUID for one deposit. Reuse it to retry or confirm the original deposit with its original quote and amount. Use a new ID for each additional deposit.

cryptoAmountnumber

Optional exact amount in cryptocurrency. Supply this or percentageOfRemaining, not both. Omit both to pay the quote amount remaining after pending and confirmed deposits.

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]

percentageOfRemainingnumber

Optional percentage of the quote remaining after pending and confirmed deposits. Greater than 0 and at most 100, with up to 6 decimal places. Calculated only for a new deposit.

Possible values: > 0 and <= 100

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