Skip to main content
POST
Simulate a payment route

Authorizations

Api-Key
string
header
required

Headers

Idempotency-Key
string

Optional idempotency/correlation key (1-64 chars). If omitted, each call produces a new simulation.

Required string length: 1 - 64

Body

application/json

Payment route simulation request

paymentRouteId
string<uuid>
required

The Rain payment route ID to simulate. Must belong to the calling tenant.

amount
string
required

The source-currency amount to simulate, as a positive decimal string in major units (for example, 100 or 1500.50).

Pattern: ^[0-9]+(\.[0-9]+)?$

Response

MXN payment route simulation completed synchronously

transactionId
string<uuid>
required

The transaction ID. Call GET /v1/transactions/:transactionId to fetch full details and current status.