API Reference — Increase

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "acknowledgement": {
    "acknowledged_at": "2020-01-31T23:59:59Z"
  },
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "creditor_name": "Ian Crease",
  "currency": "USD",
  "debtor_name": "National Phonograph Company",
  "external_account_id": null,
  "id": "fednow_transfer_4i0mptrdu1mueg1196bg",
  "idempotency_key": null,
  "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4",
  "rejection": null,
  "routing_number": "101050001",
  "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "status": "complete",
  "submission": {
    "message_identification": "20250308723260130GT4LAKENDXBHQCZDWS",
    "submitted_at": "2020-01-31T23:59:59Z"
  },
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "fednow_transfer",
  "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a",
  "unstructured_remittance_information": "Invoice 29582"
}

Attributes

account_id

string

The Account from which the transfer was sent.

More about Accounts.

account_number

string

The destination account number.

acknowledgement

dictionary

Nullable

If the transfer is acknowledged by the recipient bank, this will contain supplemental details.

amount

integer

The transfer amount in USD cents.

created_at

string

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

created_by

dictionary

Nullable

What object created the transfer, either via the API or the dashboard.

creditor_name

string

The name of the transfer’s recipient. This is set by the sender when creating the transfer.

currency

enum

The ISO 4217 code for the transfer’s currency. For FedNow transfers this is always equal to USD.

debtor_name

string

The name of the transfer’s sender. If not provided, defaults to the name of the account’s entity.

external_account_id

string

Nullable

The identifier of the External Account the transfer was made to, if any.

More about External Accounts.

string

The FedNow Transfer’s identifier.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

pending_transaction_id

string

Nullable

The ID for the pending transaction representing the transfer.

More about Pending Transactions.

rejection

dictionary

Nullable

If the transfer is rejected by FedNow or the destination financial institution, this will contain supplemental details.

routing_number

string

The destination American Bankers’ Association (ABA) Routing Transit Number (RTN).

source_account_number_id

string

The Account Number the recipient will see as having sent the transfer.

More about Account Numbers.

status

enum

The lifecycle status of the transfer.

submission

dictionary

Nullable

After the transfer is submitted to FedNow, this will contain supplemental details.

transaction_id

string

Nullable

The Transaction funding the transfer once it is complete.

More about Transactions.

type

string

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

unique_end_to_end_transaction_reference

string

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

unstructured_remittance_information

string

Unstructured information that will show on the recipient’s bank statement.

List FedNow Transfers

curl \
  --url "${INCREASE_URL}/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 FedNow Transfers to those that originated from the specified Account.

More about Accounts.

external_account_id

string

Filter FedNow Transfers to those made to the specified External Account.

More about External Accounts.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum

status.in

array of strings

Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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.

Create a FedNow Transfer

curl -X "POST" \
  --url "${INCREASE_URL}/fednow_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "account_number": "987654321",
    "amount": 100,
    "creditor_name": "Ian Crease",
    "debtor_name": "National Phonograph Company",
    "routing_number": "101050001",
    "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
    "unstructured_remittance_information": "Invoice 29582"
  }'

Parameters

account_id

string

Required

The identifier for the account that will send the transfer.

More about Accounts.

account_number

string

The creditor’s account number.

200 character maximum

amount

integer

Required

The amount, in minor units, to send to the creditor.

creditor_name

string

Required

The creditor’s name.

200 character maximum

debtor_name

string

Required

The debtor’s name.

200 character maximum

external_account_id

string

The ID of an External Account to initiate a transfer to. If this parameter is provided, account_number and routing_number must be absent.

More about External Accounts.

require_approval

boolean

Whether the transfer requires explicit approval via the dashboard or API.

routing_number

string

The creditor’s bank account routing number.

200 character maximum

source_account_number_id

string

Required

The Account Number to include in the transfer as the debtor’s account number.

More about Account Numbers.

unstructured_remittance_information

string

Required

Unstructured remittance information to include in the transfer.

200 character maximum

Retrieve a FedNow Transfer

curl \
  --url "${INCREASE_URL}/fednow_transfers/fednow_transfer_4i0mptrdu1mueg1196bg" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

fednow_transfer_id

string

Required

The identifier of the FedNow Transfer.

More about FedNow Transfers.

Approve a FedNow Transfer

curl -X "POST" \
  --url "${INCREASE_URL}/fednow_transfers/fednow_transfer_4i0mptrdu1mueg1196bg/approve" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

fednow_transfer_id

string

Required

The identifier of the FedNow Transfer to approve.

More about FedNow Transfers.

Cancel a pending FedNow Transfer

curl -X "POST" \
  --url "${INCREASE_URL}/fednow_transfers/fednow_transfer_4i0mptrdu1mueg1196bg/cancel" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

fednow_transfer_id

string

Required

The identifier of the pending FedNow Transfer to cancel.

More about FedNow Transfers.