Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Inbound FedNow Transfers

An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to your account.

The Inbound FedNow Transfer object
{
  "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",
  "unstructured_remittance_information": "Invoice 29582"
}
Attributes
account_id
string

The Account to which the transfer was sent.

More about Accounts.
account_number_id
string

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

More about Account Numbers.
amount
integer

The amount in USD cents.

confirmation
dictionary
Nullable

If your transfer is confirmed, this will contain details of the confirmation.

created_at
string

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

creditor_name
string

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

currency
enum

The ISO 4217 code of the transfer’s currency. This will always be “USD” for a FedNow transfer.

debtor_account_number
string

The account number of the account that sent the transfer.

debtor_name
string

The name provided by the sender of the transfer.

debtor_routing_number
string

The routing number of the account that sent the transfer.

decline
dictionary
Nullable

If your transfer is declined, this will contain details of the decline.

id
string

The inbound FedNow transfer’s identifier.

status
enum

The lifecycle status of the transfer.

transaction_id
string
Nullable

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

More about Transactions.
type
string

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

unstructured_remittance_information
string
Nullable

Additional information included with the transfer.

List Inbound FedNow Transfers
curl \
  --url "${INCREASE_URL}/inbound_fednow_transfers?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Inbound FedNow Transfers to those belonging to the specified Account.

More about Accounts.
account_number_id
string

Filter Inbound FedNow Transfers to ones belonging to the specified Account Number.

More about Account Numbers.
created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve an Inbound FedNow Transfer
curl \
  --url "${INCREASE_URL}/inbound_fednow_transfers/inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
inbound_fednow_transfer_id
string
Required

The identifier of the Inbound FedNow Transfer to get details for.

More about Inbound FedNow Transfers.