GET/pending_transactions

List pending transactions

Lists pending transactions that affect an account's available balance but not its current balance. Filter by account_id, route_id, category, status, or creation time to narrow the results. Use cursor to retrieve subsequent pages of results.

10 parameters
cursorstringoptional
Return the page of entries after this cursor.
limitintegeroptional
Maximum number of pending transactions to return. Defaults to 100 when omitted; the maximum is 100 and the value must be at least 1.
Default:100
account_idstringoptional
Filter pending transactions to those belonging to the specified account.
route_idstringoptional
Filter pending transactions to those belonging to the specified route.
category.inarray<string>optional
Filter by pending transaction category using a comma-delimited list of category values.
status.inarray<string>optional
Filter by status using a comma-delimited list of `pending` or `complete` values. Defaults to `pending` transactions when omitted.
created_at.afterstringoptional
Return pending transactions created after this ISO 8601 timestamp.
created_at.beforestringoptional
Return pending transactions created before this ISO 8601 timestamp.
created_at.on_or_afterstringoptional
Return pending transactions created on or after this ISO 8601 timestamp.
created_at.on_or_beforestringoptional
Return pending transactions created on or before this ISO 8601 timestamp.

3 status codes
200Returns a list of pending transaction objects and a `next_cursor` value for retrieving the next page; `next_cursor` is null when there are no further results.
dataarray<PendingTransaction>required
The contents of the list.
next_cursorstringrequired
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`.
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when the request cannot be processed because of a server-side error.

Error handling

limit must be at least 1 and is capped at 100. status.in values must be pending or complete, and the created_at filters must use ISO 8601 timestamps.