Light APIv1.0.0

API / Reference / Card Balance Accounts

Generate a card balance account statement

GET https://api.light.inc/v1/card-balance-accounts/{accountId}/statement

Generates a statement for a card balance account over a period. Dates are interpreted as UTC day boundaries and all timestamps in the response are in UTC. Runs a fresh provider sync inline so the statement reflects the latest activity.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

    Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

  • Bearer token

Path parameters

  • accountId string · uuidrequired

Query parameters

  • from string · date

    Start of the statement period, inclusive. A UTC calendar date in YYYY-MM-DD format.

  • to string · date

    End of the statement period. A UTC calendar date in YYYY-MM-DD format; must be after from.

Response

  • balanceAccountId string · uuid

  • currency string

  • periodStart string · date-time

  • periodEnd string · date-time

  • openingBalance integer · int64

  • closingBalance integer · int64

  • transactions array of object

    • providerId string

    • direction string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of DEBIT CREDIT

    • amount integer · int64

    • runningBalance integer · int64

    • bookedAt string · date-time

    • valuedAt string · date-time

    • description string

    • reference string

  • generatedAt string · date-time