Skip to main content
GET
/
fednow
List FedNow Payments
curl --request GET \
  --url https://api.treasuryprime.com/fednow \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "account_id": "<string>",
      "amount": "<string>",
      "bank_id": "<string>",
      "created_at": "<string>",
      "currency": "<string>",
      "description": "<string>",
      "error": "<string>",
      "external_account_number": "<string>",
      "external_name": "<string>",
      "external_routing_number": "<string>",
      "external_status": "<string>",
      "fed_settlement_date": "<string>",
      "id": "<string>",
      "memo": "<string>",
      "org_id": "<string>",
      "originator_name": "<string>",
      "payment_id": "<string>",
      "payment_type": "<string>",
      "related_fednow_ids": [
        "<string>"
      ],
      "security_context": {
        "device_id": "<string>",
        "ip_address": "<string>",
        "user_agent": "<string>"
      },
      "status": "<string>",
      "updated_at": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
account_id
string

ID of the account. Filterable.

​
bank_id
string

ID of the bank. Filterable.

​
external_account_number
string

External account number. Filterable.

​
org_id
string

ID of the organization. Filterable.

​
payment_id
string

FedNow payment ID. Filterable.

​
status
string

One of pending, processing, sent, done, or error. Filterable.

​
page_cursor
string

Pagination cursor, value is the object ID.

​
page_size
integer
default:100

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

Required range: x >= 1
​
from_date
string

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

​
to_date
string

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

200 - application/json

A dictionary with a data property that contains a list of up to page_size fednow elements, starting after the fednow described by page_cursor. If no more fednows are available, the resulting list will be empty.

​
data
object[]