v1

latestOpenAPI 3.1.02026-07-261520561.4 KB

FedNow

List FedNow Payments

get/fednow

Query parameters

account_idstring

ID of the account. Filterable.

bank_idstring

ID of the bank. Filterable.

external_account_numberstring

External account number. Filterable.

external_statusstring

Status of originated payment at the external account. Only populated for sent payments. One of pending, processing, done, rejected, blocked, or error. Filterable.

org_idstring

ID of the organization. Filterable.

payment_idstring

FedNow payment ID. Filterable.

statusstring

One of pending, processing, sent, done, or error. The available values for status are driven by payment type. Successful credits (incoming) terminate in done. Debits (outgoing) terminate in sent. Filterable.

page_cursorstring

Pagination cursor, value is the object ID.

page_sizeinteger

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

from_datestring

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

to_datestring

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

Response

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.