Skip to main content

SimulatePaymentRequest

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

paymentRequestIduuidrequired

The payment request ID returned from POST /v1/collections/payment-requests

Example: d4f7a8b2-1234-5678-9abc-def012345678
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
{
  "paymentRequestId": "d4f7a8b2-1234-5678-9abc-def012345678",
  "paymentMethod": "BANK_TRANSFER",
  "amount": 1000,
  "cryptoCurrency": "USDT"
}