Skip to main content
GET
/
financial-activity
List Financial Activity
curl --request GET \
  --url https://{defaultHost}/financial-activity \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "object": "ledger_activity",
      "id": "<string>",
      "line_type": "<string>",
      "amount": "<string>",
      "currency": {
        "code": "<string>",
        "precision": "<string>"
      },
      "posted_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "resource": {
        "object": "account",
        "id": "<string>",
        "title": "<string>",
        "route": "<string>",
        "logo_url": "<string>"
      },
      "source": {
        "object": "<string>",
        "id": "<string>",
        "status": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "estimated_arrival": "2023-11-07T05:31:56Z",
        "payer_name": "<string>",
        "payout_token_nickname": "<string>",
        "payout_destination": {
          "payer_name": "<string>",
          "icon_url": "<string>"
        }
      }
    }
  ],
  "page_info": {
    "has_next_page": true,
    "end_cursor": "<string>",
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token.

Query Parameters

account_id
string

The owning account ID (a biz_ identifier). Provide this or user_id.

user_id
string

The owning user ID (a user_ identifier). Provide this or account_id.

line_types
string[]

Optional ledger line categories to include. Some categories (for example onchain_deposit, which covers inbound crypto deposits such as MoonPay onramps) are only returned when explicitly requested here.

currency
string

Optional currency code filter, for example usd.

posted_after
string<date-time>

Only include rows posted after this ISO 8601 timestamp.

posted_before
string<date-time>

Only include rows posted before this ISO 8601 timestamp.

limit
integer
default:20

Maximum number of rows to return.

Required range: x <= 100
cursor
string

Cursor returned by the previous page.

Response

activities listed for a user

data
object[]
required
page_info
object
required