List account transfers

GET

https://api.useroot.com/api/treasury/account-transfers

GET

/api/treasury/account-transfers

$ curl https://api.useroot.com/api/treasury/account-transfers \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "data": [
3     {
4       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5       "from_account_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
6       "to_account_id": "b2c3d4e5-f678-90ab-cdef-1234567890ab",
7       "amount_in_minor_units": 250000,
8       "currency_code": "USD",
9       "rail": "standard_ach",
10       "status": "settled",
11       "created_at": "2024-01-15T09:30:00Z",
12       "updated_at": "2024-01-15T10:00:00Z",
13       "client_metadata": {
14         "reference": "Invoice #12345",
15         "initiated_by": "finance_team"
16       }
17     }
18   ],
19   "has_more": true,
20   "total_count": 1,
21   "next_cursor": "3fa85f64-5717-4562-b3fc-2c963f66afb0",
22   "previous_cursor": "3fa85f64-5717-4562-b3fc-2c963f66afa0"
23 }

Authentication

x-api-keystring

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

Query parameters

cursorstring or nullOptional

Cursor for pagination. Use the next_cursor from the previous response to get the next page.

limitintegerOptional10-500Defaults to 50

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

orderenumOptional

Sort order for results by creation time.

Allowed values:

account_idlist of strings or nullOptional

Filter by main account ID; repeat the parameter to match any listed account as from or to (OR).

amount_in_minor_units_gteinteger or nullOptional

Inclusive lower bound for transfer amount in minor units.

amount_in_minor_units_lteinteger or nullOptional

Inclusive upper bound for transfer amount in minor units.

created_at_gtedatetime or nullOptional

Created on or after this timestamp.

created_at_ltedatetime or nullOptional

Created on or before this timestamp.

raillist of enums or nullOptional

Filter by rail; repeat the parameter for multiple rails (OR).

statuslist of enums or nullOptional

Filter by status; repeat the parameter for multiple statuses (OR).

Response

Successful Response

datalist of objects

has_moreboolean

total_countinteger or null>=0Defaults to 0

next_cursorstring or null

previous_cursorstring or null