Lithic API Documentation | Account Activity

Account Activity

account_activity

Methods

List Account Activity -> CursorPage<{ token, category, created, 10 more... } |

BookTransferResponse

Transaction

| 3 more...>

get/v1/account_activity

Retrieve a list of transactions across all public accounts.

query Parameters

account_token: string

Optional

(format: uuid)

Filter by account token

begin: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

business_account_token: string

Optional

(format: uuid)

Filter by business account token

category:

Optional

Filter by transaction category

"ACH"

"BALANCE_OR_FUNDING"

"FEE"

"REWARD"

"ADJUSTMENT"

"DERECOGNITION"

"DISPUTE"

"CARD"

"EXTERNAL_ACH"

"EXTERNAL_CHECK"

"EXTERNAL_FEDNOW"

"EXTERNAL_RTP"

"EXTERNAL_TRANSFER"

"EXTERNAL_WIRE"

"MANAGEMENT_ADJUSTMENT"

"MANAGEMENT_DISPUTE"

"MANAGEMENT_FEE"

"MANAGEMENT_REWARD"

"MANAGEMENT_DISBURSEMENT"

"PROGRAM_FUNDING"

end: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

ending_before: string

Optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

financial_account_token: string

Optional

(format: uuid)

Filter by financial account token

page_size: number

Optional

(maximum: 100, minimum: 1, default: 50)

Page size (for pagination).

result:

Optional

Filter by transaction result

"APPROVED"

"DECLINED"

starting_after: string

Optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

status:

Optional

Filter by transaction status

"DECLINED"

"EXPIRED"

"PENDING"

"RETURNED"

"REVERSED"

"SETTLED"

"VOIDED"

Response fields

data: Array<{ token, category, created, 10 more... } |

BookTransferResponse

Transaction

| 3 more...>

Optional

has_more: boolean

Optional

Indicates if there are more transactions available for pagination

Request example

curl https://api.lithic.com/v1/account_activity \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "category": "ACH",
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "USD",
      "descriptor": "descriptor",
      "events": [
        {
          "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "amount": 0,
          "created": "2019-12-27T18:11:19.117Z",
          "result": "APPROVED",
          "type": "ACH_ORIGINATION_CANCELLED"
        }
      ],
      "family": "INTERNAL",
      "financial_account_token": "0cc87075-57cf-4607-8722-f42e2cb2c0cd",
      "pending_amount": 500,
      "result": "APPROVED",
      "settled_amount": 200,
      "status": "PENDING",
      "updated": "2019-12-27T18:11:19.117Z"
    }
  ],
  "has_more": true
}

Get Single Transaction From Account Activity -> { token, category, created, 10 more... } |

BookTransferResponse

Transaction

| 3 more...

get/v1/account_activity/{transaction_token}

Retrieve a single transaction

Domain types

WirePartyDetails = { account_number, agent_id, agent_name, 1 more... }