Skip to main content

SimulatePaymentResponse

Result of a simulated payment in sandbox environments

paymentRequestIduuid

The payment request ID

paymentIduuid

The ID of the simulated payment. Use this to query payment details via GET /v1/collections/payment-requests/{paymentRequestId}

paymentReferencestring

The unique reference for the simulated payment

paymentMethodstring

The payment method that was simulated

Possible values: [BANK_TRANSFER, CRYPTO, CARD]

amountnumber

The amount that was simulated

currencystring

The currency of the payment

Example: AED
paymentRequestStatusstring

The updated status of the payment request after simulation (PAID or PART_PAID)

SimulatePaymentResponse
{
"paymentRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentReference": "string",
"paymentMethod": "BANK_TRANSFER",
"amount": 0,
"currency": "AED",
"paymentRequestStatus": "string"
}