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.
Hide attributes
integer
required
Amount in cents.
string
required
Currency code. Always USD.
object | null
required
Fee added to your cost as the sender. Null when no fee applies, the payment failed, was denied, or was canceled, the fee was voided, or your party is not the fee payer.
Hide fee
integer
required
Fee amount in cents.
string
required
Currency of the fee. Always USD.
string
required
Party role charged the fee. Always sender.
string
required
The fee is added to the sender’s cost without reducing the principal amount. Always on_top.
string
required
Realtime payment status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, SETTLED; APPROVAL_DENIED, FAILED, or CANCELED end it. One of: CREATED, AWAITING_APPROVAL, APPROVAL_DENIED, PROCESSING, SETTLED, FAILED, CANCELED. See Statuses.
string
required
Payment description delivered to the recipient bank.
string | null
required
Description for your internal reference, or null. Never shared with the counterparty or the banking network.
object | null
required
Failure details when the payment failed, or null.
Hide failure
string | null
required
Failure reason, or null.
string | null
required
Failure code, or null.
string | null
required
RFC 3339 timestamp when the payment was submitted to the network, or null.
string | null
required
RFC 3339 timestamp when the payment settled, or null. Settled realtime payments cannot be returned.
string | null
required
RFC 3339 timestamp when the payment reached a terminal status, or null.
string
required
RFC 3339 timestamp when the realtime payment was created.
string
required
RFC 3339 timestamp when the realtime payment was last updated.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Agent that initiated this resource, or null when no agent can be reliably attributed.
Hide initiatorAgent
object | null
required
Related resource identifier.
Hide data
string
required
Resource type. Always agent.
string
required
Agent ID (agt_*).
object
required
Party the payment was created for.
Hide customerParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
Party ID (pty_*).
object
required
Wallet the payment pays from.
Hide wallet
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always wallet.
string
required
Wallet ID (wal_*).
object
required
External party paid.
Hide externalParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always externalParty.
string
required
External party ID (epty_*).
object
required
External party account paid.
Hide externalPartyAccount
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always externalPartyAccount.
string
required
External party account ID (epa_*).
Statuses
Status
Meaning
Can become
CREATED
Natural saved the payment and hasn’t sent it to the network yet.
Your approval policy or an approver denied the payment before it was sent.
Final
PROCESSING
Sent to the network and not settled yet.
SETTLED, FAILED
SETTLED
The payment settled. A settled realtime payment can’t be returned.
Final
FAILED
The payment didn’t go through, for example because the network rejected it. failure says why.
Final
CANCELED
Canceled before it was sent, for example by you or when its approval was canceled.
Final
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.