The Realtime Transfer object

InstantPayment is a FedNow or RTP payment: a customer credit transfer, a liquidity management transfer, or the return of one.

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

counterpartyobjectRequired

4 child attributes

account_numberstringRequired

account_typestringRequired

namestringRequired

routing_numberstringRequired

cycle_datestring · date or nullOptional

A business date, YYYY-MM-DD

directionstringRequired

end_to_end_idstringRequired

gl_codestringRequired

A liquidity transfer's GL account, or the transit account a held payment waits on

idstringRequired

Example rttr_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

Customer, liquidity or return

msg_idstringRequired

operatorstringRequired

original_idstringRequired

On a return: the payment returned

railstringRequired

reason_codestringRequired

reason_infostringRequired

remittancestringRequired

request_idstringRequired

The request for payment this payment settles

Example req_2tVh8nqLxq4GbDe0K1F6S9zRcWm

return_reasonstringRequired

return_reason_codestringRequired

screening_resultstringRequired

statusstringRequired

Pending, held_for_review, rejected, sent, accepted, accepted_without_posting, posted, blocked, rejected_by_rail, received, returned

uetrstringRequired