Skip to main content

Simulate a payment (Sandbox)

POST 
/v1/collections/simulate-payment

Simulates a card, bank transfer or crypto payment against an existing payment request. This triggers the full payment lifecycle including status updates and webhook notifications, without requiring actual bank transfers or cryptocurrency transactions.

The payment request must be in UNPAID or PART_PAID status. If no amount is specified, the full remaining balance is used. Amount is in the request's fiat currency. To test an existing checkout crypto quote, pending deposits, split deposits or quote expiry, use simulate-crypto-deposit and simulate-expiry.

After a successful simulation:

  • The payment request status will be updated to PAID (or PART_PAID for partial amounts)
  • Webhook notifications will be sent to your registered endpoints
  • The payment will be visible when querying the payment request
  • The wallet balance will be updated

This endpoint is only available in sandbox/test environments.

Request​

Responses​

OK

Response Headers
    X-Trace-Id

    Trace ID to provide when contacting Hubpay support