Skip to main content

Simulate a crypto deposit (Sandbox)

POST 
/v1/collections/simulate-crypto-deposit

Simulates a pending or confirmed deposit against an existing checkout crypto quote using its token, network and rate. The payment request must belong to the selected account. Omit quotePaymentId to select the latest quote. Omit cryptoAmount and percentageOfRemaining to pay its remaining amount after pending and confirmed deposits. Alternatively supply an exact cryptoAmount or percentageOfRemaining, not both. New deposits require an open quote and an UNPAID or PART_PAID request. Reuse depositId to retry or confirm the original deposit with its original quote and amount, including after expiry or a quote refresh. Use a new depositId for each split deposit. Total deposits cannot exceed the quote amount. Confirmation updates received funds and queues the normal confirmation webhooks; wallet credit requires simulate-payment-completion. This does not send an on-chain transaction. Available only in sandbox/test environments with the usual collections authorization.

Request​

Responses​

OK

Response Headers
    X-Trace-Id

    Trace ID to provide when contacting Hubpay support