Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Sandbox: Create an Inbound FedNow Transfer

Simulates an Inbound FedNow Transfer to your account.

post/simulations/inbound_fednow_transfers

Request body

account_number_idstring required

The identifier of the Account Number the inbound FedNow Transfer is for.

amountinteger required

The transfer amount in USD cents. Must be positive.

debtor_account_numberstring

The account number of the account that sent the transfer.

debtor_namestring

The name provided by the sender of the transfer.

debtor_routing_numberstring

The routing number of the account that sent the transfer.

unstructured_remittance_informationstring

Additional information included with the transfer.

Example request

{
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 1000
}

Response

Inbound FedNow Transfer

account_idstring required

The Account to which the transfer was sent.

account_number_idstring required

The identifier of the Account Number to which this transfer was sent.

amountinteger required

The amount in USD cents.

created_atstring date-time required

The ISO 8601 date and time at which the transfer was created.

creditor_namestring required

The name the sender of the transfer specified as the recipient of the transfer.

currency'USD' required

The ISO 4217 code of the transfer's currency. This will always be "USD" for a FedNow transfer.

debtor_account_numberstring required

The account number of the account that sent the transfer.

debtor_namestring required

The name provided by the sender of the transfer.

debtor_routing_numberstring required

The routing number of the account that sent the transfer.

idstring required

The inbound FedNow transfer's identifier.

status'pending_confirming' | 'timed_out' | 'confirmed' | 'declined' | 'requires_attention' required

The lifecycle status of the transfer.

transaction_idstring nullable required

The identifier of the Transaction object created when the transfer was confirmed.

type'inbound_fednow_transfer' required

A constant representing the object's type. For this resource it will always be inbound_fednow_transfer.

unique_end_to_end_transaction_referencestring nullable required

The Unique End-to-end Transaction Reference (UETR) of the transfer.

unstructured_remittance_informationstring nullable required

Additional information included with the transfer.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "confirmation": {
    "transfer_id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_name": "Ian Crease",
  "currency": "USD",
  "debtor_account_number": "987654321",
  "debtor_name": "National Phonograph Company",
  "debtor_routing_number": "101050001",
  "decline": {
    "reason": "account_number_disabled",
    "transfer_id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20"
  },
  "id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20",
  "status": "confirmed",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "inbound_fednow_transfer",
  "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a",
  "unstructured_remittance_information": "Invoice 29582"
}