increase-test
POST/simulations/inbound_real_time_payments_transfers

Sandbox: Create an Inbound Real-Time Payments Transfer

Simulates an Inbound Real-Time Payments Transfer to your account. Real-Time Payments are a beta feature.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

7 body fields
account_number_idstringrequired
The identifier of the Account Number the inbound Real-Time Payments Transfer is for.
amountintegerrequired
The transfer amount in USD cents. Must be positive.
debtor_account_numberstringoptional
The account number of the account that sent the transfer.
debtor_namestringoptional
The name provided by the sender of the transfer.
debtor_routing_numberstringoptional
The routing number of the account that sent the transfer.
request_for_payment_idstringoptional
The identifier of a pending Request for Payment that this transfer will fulfill.
unstructured_remittance_informationstringoptional
Additional information included with the transfer.

3 status codes
200Inbound Real-Time Payments Transfer
account_idstringrequired
The Account to which the transfer was sent.
account_number_idstringrequired
The identifier of the Account Number to which this transfer was sent.
amountintegerrequired
The amount in USD cents.
confirmationobjectrequired
If your transfer is confirmed, this will contain details of the confirmation.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
creditor_namestringrequired
The name the sender of the transfer specified as the recipient of the transfer.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
Allowed:USD
debtor_account_numberstringrequired
The account number of the account that sent the transfer.
debtor_namestringrequired
The name provided by the sender of the transfer.
debtor_routing_numberstringrequired
The routing number of the account that sent the transfer.
declineobjectrequired
If your transfer is declined, this will contain details of the decline.
idstringrequired
The inbound Real-Time Payments transfer's identifier.
statusstringrequired
The lifecycle status of the transfer.
Allowed:pending_confirmingtimed_outconfirmeddeclined
transaction_identificationstringrequired
The Real-Time Payments network identification of the transfer.
typestringrequired
A constant representing the object's type. For this resource it will always be `inbound_real_time_payments_transfer`.
Allowed:inbound_real_time_payments_transfer
unstructured_remittance_informationstringrequired
Additional information included with the transfer.
4XXError
5XXError