Simulate another institution's customer asking the bank's customer to pay (pain.013)
POST
/simulate/transfers/realtime/requestHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
account_numberstringRequiredThe payer's account at the bank
amountintegerRequiredcreditor_accountstringRequiredcreditor_namestringRequiredcreditor_routing_numberstringRequireddocument_numberstringOptionalexpires_atstring · date-time or nullOptionalrailstringRequiredremittancestringOptionalReturns
200 OK
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
amountintegerRequiredcancellation_reason_codestringRequiredcancellation_statusstringRequiredRequested, cancelled, refused, failed
counterpartyobjectRequired4 child attributes
account_numberstringRequiredaccount_typestringRequirednamestringRequiredrouting_numberstringRequiredcreated_atstring · date-timeRequireddirectionstringRequireddocument_numberstringRequiredexpires_atstring · date-time or nullOptionalidstringRequiredmsg_idstringRequiredpayment_idstringRequiredExample lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm
railstringRequiredreasonstringRequiredreason_codestringRequiredremittancestringRequiredrequested_execution_datestring · dateRequiredA business date, YYYY-MM-DD
statusstringRequiredSent, acknowledged, received, presented, accepted, paid, rejected, expired, cancelled, failed
uetrstringRequiredupdated_atstring · date-timeRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503