Skip to main content
A realtime payment (rt_*) pushes money from a wallet to an external party account over RTP or FedNow. To learn more, see Pay over a specific rail.

Example

GET /realtime/{realtimeId}
The object is everything inside data. The field names below are relative to it: attributes.amount is data.attributes.amount in the response.

Fields

string
required
Resource type. Always realtime.
string
required
Realtime payment ID (rt_*).
object
required
The payment’s details.
object
required
Related resources, each by type and ID.

Statuses

Events

  • realtime.created: A realtime payment was created. The fee is assessed when the payment is submitted, so it’s always null on realtime.created. Read it from realtime.processing.
  • realtime.processing: A realtime payment was accepted by money movement and is processing.
  • realtime.settled: A realtime payment settled. Settled realtime transfers are irrevocable; there is no return state.
  • realtime.failed: A realtime payment was rejected and failed terminally.

Errors

See the error codes these endpoints return.

Sandbox simulations