List subaccount activity

GET

https://api.useroot.com/api/subaccounts/:subaccount_id/activity

GET

/api/subaccounts/:subaccount_id/activity

$ curl https://api.useroot.com/api/subaccounts/subaccount_id/activity \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "data": [
3     {
4       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5       "source": "transfer",
6       "direction": "credit",
7       "amount_in_cents": 12500,
8       "effective_at": "2024-01-15T09:30:00Z",
9       "amount_in_minor_units": null,
10       "currency_code": "USD"
11     },
12     {
13       "id": "7b9e1d2a-4f3c-4a1b-9f3d-8a2e5c9f7b1d",
14       "source": "bai2",
15       "direction": "debit",
16       "amount_in_cents": 5000,
17       "effective_at": "2024-01-14T14:45:00Z",
18       "amount_in_minor_units": null,
19       "currency_code": "USD"
20     }
21   ],
22   "has_more": true,
23   "total_count": 2,
24   "next_cursor": "3fa85f64-5717-4562-b3fc-2c963f66afb0",
25   "previous_cursor": "7b9e1d2a-4f3c-4a1b-9f3d-8a2e5c9f7b1c"
26 }

Return a consolidated list of subaccount activity from transfer and BAI2 sources.

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

subaccount_idstringRequiredformat: "uuid"

The subaccount ID

Query parameters

cursorstring or nullOptional

Cursor for pagination.

limitinteger or nullOptional10-500Defaults to 50

Number of items to return per page. Maximum is 500.

orderenum or nullOptionalDefaults to desc

Sort order by created_at: ‘asc’ for oldest first, ‘desc’ for newest first (default: ‘desc’)

Allowed values:

directionenum or nullOptional

Filter by direction from subaccount perspective.

Allowed values:

amount_gteinteger or nullOptional

Minimum amount in cents.

amount_lteinteger or nullOptional

Maximum amount in cents.

effective_at_gtedatetime or nullOptional

Effective timestamp on/after this value (UTC).

effective_at_ltedatetime or nullOptional

Effective timestamp on/before this value (UTC).

Response

Successful Response

datalist of objects

has_moreboolean

total_countinteger or null>=0Defaults to 0

next_cursorstring or null

previous_cursorstring or null