List remittances
Remittances
List remittances
Retrieve an entity’s remittances and whether an 835 is available for each.
GET
List remittances
Returns a paginated list of an entity’s remittances, ordered by most recently
updated first. Only remittances derived from an electronic remittance advice —
those an 835 can be generated from — are returned. Results are
paginated.
Each remittance exposes whether its 835 is currently available. Fetch the 835
itself with Fetch a remittance’s 835.
Query parameters
string
required
The ID of the entity whose remittances to list. You can find entity IDs using
the List entities endpoint.
string
Return only remittances updated at or after this timestamp (ISO 8601). Pass
the largest
updated_at you have already seen to poll for changes
incrementally.string
Return only remittances with a remittance date on or after this date
(YYYY-MM-DD).
string
Return only remittances with a remittance date on or before this date
(YYYY-MM-DD).
string
Return only remittances whose payer name contains this text.
integer
default:"10"
Maximum number of remittances to return per page. Maximum is 100.
string
Pagination cursor for retrieving the next page of results. Returned as
cursor in the response. See pagination for
details.Response
object[]
The list of remittance objects.
Only remittances whose 835 is ready to serve are listed, so every
id here
resolves on Fetch a remittance’s 835.boolean
Whether more remittances exist beyond this page. Use the
cursor field to
retrieve the next page.string | null
Cursor to retrieve the next page of results. Null if this is the last page.
Pass this value as the
cursor query parameter in a subsequent request. See
pagination for details.