Skip to main content

SimulatePaymentRequest

Request to simulate a payment against a payment request in sandbox environments

paymentRequestReferencestringrequired

Identifies the payment request. Supply any one of:

  • the id returned by POST /v1/collections/payment-requests
  • your client-provided externalId
  • Hubpay's paymentLinkReference (the reference in the payment URL)

The legacy JSON field name paymentRequestId is also accepted.

Possible values: non-empty

Example: REQ-123456
paymentMethodstringrequired

The payment method to simulate

Possible values: [BANK_TRANSFER, CRYPTO, CARD]

Example: BANK_TRANSFER
amountnumber

Amount to simulate. If omitted, the full remaining balance is used

Example: 1000
cryptoCurrencystring

Cryptocurrency to simulate (USDT or USDC). Defaults to USDT. Only applicable when paymentMethod is CRYPTO

Example: USDT
SimulatePaymentRequest
{
  "paymentRequestReference": "REQ-123456",
  "paymentMethod": "BANK_TRANSFER",
  "amount": 1000,
  "cryptoCurrency": "USDT"
}