v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Pending Transactions

get/pending_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 pending transactions to those belonging to the specified Account.

route_idstring

Filter pending transactions to those belonging to the specified Route.

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.

status.instring[]

Filter Pending Transactions for those with the specified status. By default only Pending Transactions in with status pending will be returned. 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

Pending 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,
      "completed_at": null,
      "created_at": "2020-01-31T23:59:59Z",
      "currency": "USD",
      "description": "INVOICE 2468",
      "held_amount": -100,
      "id": "pending_transaction_k1sfetcau2qbvjbzgju4",
      "route_id": null,
      "route_type": null,
      "source": {
        "ach_transfer_instruction": {
          "amount": 100,
          "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q"
        },
        "category": "ach_transfer_instruction"
      },
      "status": "pending",
      "type": "pending_transaction"
    }
  ],
  "next_cursor": "v57w5d"
}