Retrieve Ledger Entries for an Account

Specifications

Resquest

JSON PATHDescriptionExampleFormatRequired
account_idThe Identifier associated to Accountfcd0cecb-90dd-4ae2-879f-d0eda6fbddd4UUIDYes
from_dateEntries from the date (YYYY-MM-DD) populated will be retrieved2025-01-01stringYes
to_dateOnly entries before the date (YYYY-MM-DD) will be retrieved2025-02-01stringYes
from_timeOnly entries from the time (HH-MM-SS) populated will be retrieved. If not populated, all entries will be retrieved12-24-46stringNo
to_timeOnly entries before the time (HH-MM-SS) will be retrieved. If not populated, all entries will be retrieved14-10-25stringNo
sortEnables you to order from the newest (asc) to the oldest or oldest (desc) to newestascstringNo
limitTo limit the number of Customer records to be returned per request. Use the new_page_token for pagination1000stringNo
next_page_tokenTo retrieve the next selection of entries, the new_page_token is requiredaWQrdGltZQo=stringNo

Response

JSON PATHDescriptionExampleFormatRequired
account_idThe Identifier associated to Accountfcd0cecb-90dd-4ae2-879f-d0eda6fbddd4UUIDYes
dateThe date of the entry in YYYY-MM-DD format2025-01-01stringYes
timeThe time of the entry in HH-MM-SS12-32-32stringYes
amountThe amount of the entry10000stringYes
movement_typeIdentifies the type of movement, either via Network, Credit API or other meansauthorizationstringYes
movement_sourceIdentifies the source of the movement_typependingstringYes
fee_includedIndicates if the movement amount includes a fee (y = Yes, or n = No). If yes, the fee_amount will be populatedystringNo
fee_amountThe amount of the fee100stringNo
referenceOptional information provided at the time of the movementOptional information provided at the time of the movementstringNo
reference_idOptional and is only populated following an Account to Account transferOptional and is only populated following an Account to Account transferstringNo
next_page_tokenToken - required for next page listingaWQrdGltZQo=stringNo
countTotal count of items.10stringNo`
trace_idThe Identifier associated with the API15bfc289-de75-4668-bb11-3998aadf226dstringYes

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"
}