Get ledger statement of account

import requests
url = "https://api-sandbox.koywe.com/api/v1/organizations/org3_8821b7b4-7f0c-45d9-aa5f-a9ce41ee2f1e/merchants/mrc_2e8f96ab-dbd5-45f9-b4b6-645945daf340/accounts/acc_0031c537-2301-40ab-9153-0f7c48505350/reports/ledger-statement"
querystring = {"from":"2025-01-01","to":"2025-01-31"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "accountId": "acc_abc123",
  "currency": "CLP",
  "merchantId": "mrc_xyz789",
  "periodStart": "2025-01-01T00:00:00Z",
  "periodEnd": "2025-01-31T23:59:59Z",
  "openingBalance": "4000000.00",
  "closingBalance": "5500000.00",
  "movements": [
    {
      "ledgerEntryId": "137",
      "postedAt": "2025-01-15T10:30:00Z",
      "type": "debit",
      "amount": "1000000.00",
      "currency": "CLP",
      "runningBalance": "5000000.00",
      "description": "PAYIN from Juan Pérez - Bank transfer received",
      "category": "PAYIN",
      "orderId": "ord_abc123"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 50,
    "cursor": "eyJpZCI6IjEzNyIsImRhdGUiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoifQ=="
  },
  "generatedAt": "2025-01-31T12:00:00Z"
}

Retrieves a bank-style statement of account showing all ledger movements that affected the merchant’s balance for the specified account and date range.

Features:

Opening balance at period start
Chronological list of all movements (debits and credits)
Running balance after each movement
Closing balance at period end
Human-readable descriptions enriched from order context

Date Range:

Use from and to parameters in YYYY-MM-DD format
Maximum range is 365 days
Granularity parameter controls date cutoffs (daily or monthly)

Pagination:

Uses cursor-based pagination
The cursor from the response can be used to fetch the next page
Default page size is 50, maximum is 100

Example: GET /v1/organizations/org3_xxx/merchants/mrc_xxx/accounts/acc_xxx/reports/ledger-statement?from=2025-01-01&to=2025-01-31&granularity=daily&limit=50

Retrieves a bank-style statement of account showing all ledger movements that affected the merchant's balance for the specified account and date range. **Features:** - Opening balance at period start - Chronological list of all movements (debits and credits) - Running balance after each movement - Closing balance at period end - Human-readable descriptions enriched from order context **Date Range:** - Use `from` and `to` parameters in YYYY-MM-DD format - Maximum range is 365 days - Granularity parameter controls date cutoffs (daily or monthly) **Pagination:** - Uses cursor-based pagination - The `cursor` from the response can be used to fetch the next page - Default page size is 50, maximum is 100 **Example:** `GET /v1/organizations/org3_xxx/merchants/mrc_xxx/accounts/acc_xxx/reports/ledger-statement?from=2025-01-01&to=2025-01-31&granularity=daily&limit=50`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Organization ID

merchantIdstringRequired

Merchant ID

accountIdstringRequired

Virtual account ID (must be a virtual account)

Query parameters

fromstringRequired

Start date (YYYY-MM-DD)

tostringRequired

End date (YYYY-MM-DD)

granularityenumOptionalDefaults to daily

Report granularity for date cutoffs

Allowed values:

cursorstringOptional

Cursor for pagination (from previous response)

limitdoubleOptional1-100Defaults to 50

Number of items per page

Response

Ledger statement generated successfully

accountIdstring

Virtual account ID

currencystring

Currency of the account

merchantIdstring

Merchant ID

periodStartdatetime

Start of the reporting period

periodEnddatetime

End of the reporting period

openingBalancestring

Balance at the start of the period

closingBalancestring

Balance at the end of the period

movementslist of objects

List of movements in chronological order

paginationobject

Pagination information

generatedAtdatetime

Timestamp when this report was generated

Errors