v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

List Transactions

get/transactions

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 Transactions for those belonging to the specified Account.

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.

category.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.

route_idstring

Filter Transactions for those belonging to the specified route. This could be a Card ID or an Account Number ID.

Response

Transaction 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",
      "amount": 100,
      "created_at": "2020-01-31T23:59:59Z",
      "currency": "USD",
      "description": "INVOICE 2468",
      "id": "transaction_uyrp7fld2ium70oa7oi",
      "route_id": "account_number_v18nkfqm6afpsrvy82b2",
      "route_type": "account_number",
      "source": {
        "category": "inbound_ach_transfer",
        "inbound_ach_transfer": {
          "addenda": null,
          "amount": 100,
          "originator_company_descriptive_date": null,
          "originator_company_discretionary_data": null,
          "originator_company_entry_description": "RESERVE",
          "originator_company_id": "0987654321",
          "originator_company_name": "BIG BANK",
          "receiver_id_number": "12345678900",
          "receiver_name": "IAN CREASE",
          "trace_number": "021000038461022",
          "transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev"
        }
      },
      "type": "transaction"
    }
  ],
  "next_cursor": "v57w5d"
}