Retrieve Ledger Entries for an Account
Specifications
Resquest
JSON PATH | Description | Example | Format | Required |
---|---|---|---|---|
account_id | The Identifier associated to Account | fcd0cecb-90dd-4ae2-879f-d0eda6fbddd4 | UUID | Yes |
from_date | Entries from the date (YYYY-MM-DD) populated will be retrieved | 2025-01-01 | string | Yes |
to_date | Only entries before the date (YYYY-MM-DD) will be retrieved | 2025-02-01 | string | Yes |
from_time | Only entries from the time (HH-MM-SS) populated will be retrieved. If not populated, all entries will be retrieved | 12-24-46 | string | No |
to_time | Only entries before the time (HH-MM-SS) will be retrieved. If not populated, all entries will be retrieved | 14-10-25 | string | No |
sort | Enables you to order from the newest (asc) to the oldest or oldest (desc) to newest | asc | string | No |
limit | To limit the number of Customer records to be returned per request. Use the new_page_token for pagination | 1000 | string | No |
next_page_token | To retrieve the next selection of entries, the new_page_token is required | aWQrdGltZQo= | string | No |
Response
JSON PATH | Description | Example | Format | Required |
---|---|---|---|---|
account_id | The Identifier associated to Account | fcd0cecb-90dd-4ae2-879f-d0eda6fbddd4 | UUID | Yes |
date | The date of the entry in YYYY-MM-DD format | 2025-01-01 | string | Yes |
time | The time of the entry in HH-MM-SS | 12-32-32 | string | Yes |
amount | The amount of the entry | 10000 | string | Yes |
movement_type | Identifies the type of movement, either via Network, Credit API or other means | authorization | string | Yes |
movement_source | Identifies the source of the movement_type | pending | string | Yes |
fee_included | Indicates if the movement amount includes a fee (y = Yes, or n = No). If yes, the fee_amount will be populated | y | string | No |
fee_amount | The amount of the fee | 100 | string | No |
reference | Optional information provided at the time of the movement | Optional information provided at the time of the movement | string | No |
reference_id | Optional and is only populated following an Account to Account transfer | Optional and is only populated following an Account to Account transfer | string | No |
next_page_token | Token - required for next page listing | aWQrdGltZQo= | string | No |
count | Total count of items. | 10 | string | No` |
trace_id | The Identifier associated with the API | 15bfc289-de75-4668-bb11-3998aadf226d | string | Yes |
Example
{
"accounts": [
{
"account_id": "8eaa391e-618f-47e7-a5fe-7c9ea1a21281",
"date": "2025-01-01T00:00:00.000Z",
"time": "12-32-32",
"amount": 10000,
"movement_type": "authorization",
"movement_source": "pending",
"fee_included": "y",
"fee_amount": 100,
"reference": "Bank Transfer for Birthday",
"reference_id": "CLOWD9 Adjustment 20250705"
}
],
"next_page_token": "aWQrdGltZQo=",
"count": "10",
"trace_id": "a2ad322a-a2f9-3a5a-b0a9-e0d5c0f5b9f6"
}
Updated 5 days ago