Skip to main content
GET
List Transactions

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

Unique identifier for object

Query Parameters

ach_id
string

The ID of the ACH object that originated this transaction, if any. Otherwise null. Filterable.

book_id
string

The ID of the Book Transfer object that originated this transaction, if any. Otherwise null. Filterable.

card_id
string

The ID of the Card Object that originated this transaction, if any. Otherwise null. Filterable.

check_id
string

The ID of the Check Deposit object that originated this transaction, if any. Otherwise null. Filterable.

fednow_id
string

The ID of the Fednow object that originated this transaction, if any. Otherwise null. Filterable.

greendot_deposit_id
string

The ID of the Prime Cash object that the transaction is related to. Otherwise null. Filterable.

issued_check_id
string

The ID of the Issued Check Object that originated this transaction, if any. Otherwise null. Filterable.

network_transfer_id
string

The ID of the Network Transfer that originated this transaction, if any. Otherwise null. Filterable.

posted
enum<string>

true to filter the transactions that have posted. Filterable.

Available options:
true,
false
trace_id
string

A common id used to tie multiple, related transactions together. Currently used to connect hold and hold_release transactions to a debit and to link transactions to their related card events. Filterable.

type
string

Type of transaction. One of charge, deposit, hold, hold_release, interest, payment, reversal, withdrawal, or null. Filterable.

type_source
string

The type of payment that initiated this transaction, if any. One of ach, bank, book, card, check, fednow, greendot, or wire. Otherwise null. Limited availability. Filterable.

wire_id
string

The ID of the Wire object that originated this transaction, if any. Otherwise null. Filterable.

page_cursor
string

Pagination cursor, value is the object ID.

page_size
integer
default:100

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

Required range: x >= 1
from_date
string

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

to_date
string

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

Response

200 - application/json

A dictionary with a data property that contains a list of up to page_size transaction elements, starting after the transaction described by page_cursor. If no more transactions are available, the resulting list will be empty.

data
object[]