List FedNow Transfers

Changed on
get/fednow_transfers

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/fednow_transfers
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

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

account_idstring

Filter FedNow Transfers to those that originated from the specified Account.

external_account_idstring

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

idempotency_keystring

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.

status.instring[]

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.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

Response

FedNow Transfer List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "account_id": "account_in71c4amph0vgo2qllky",
      "account_number": "987654321",
      "acknowledgement": {
        "acknowledged_at": "2020-01-31T14:10:02Z"
      },
      "amount": 100,
      "created_at": "2020-01-31T14:00:00Z",
      "created_by": {
        "category": "user",
        "user": {
          "email": "user@example.com"
        }
      },
      "creditor_address": {
        "city": "New York",
        "line1": "33 Liberty Street",
        "postal_code": "10045",
        "state": "NY"
      },
      "creditor_name": "Ian Crease",
      "currency": "USD",
      "debtor_address": {
        "city": "New York",
        "line1": "33 Liberty Street",
        "postal_code": "10045",
        "state": "NY"
      },
      "debtor_name": "National Phonograph Company",
      "external_account_id": null,
      "id": "fednow_transfer_4i0mptrdu1mueg1196bg",
      "idempotency_key": null,
      "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4",
      "rejection": null,
      "returns": [],
      "routing_number": "101050001",
      "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "status": "complete",
      "submission": {
        "message_identification": "20250308723260130GT4LAKENDXBHQCZDWS",
        "submitted_at": "2020-01-31T14:10:00Z"
      },
      "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
      "type": "fednow_transfer",
      "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a",
      "unstructured_remittance_information": "Invoice 29582"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

  • e73761b43130Revision changes
    • warning

      added the new returned enum value to the // response property for the response status

    • info

      added the enum value returned to the property items/ of the query request parameter status.in

    • info

      added the required property // to the response with the status

  • 60a219d7f03fRevision changes
    • breaking

      removed the enum value reviewing_rejected from the property items/ of the query request parameter status.in

    • info

      removed the reviewing_rejected enum value from the // response property for the response status