BVbvnk
Wallets

Generate report

Changed on

Creates a report from a wallet in the specified format and sends it via the preferred delivery method: WEBHOOK or EMAIL.

The report type is determined by the type field in the request body:

  • TRANSACTION returns all transactions within a date range (from / to).
  • BALANCE returns the wallet balance at a specific point in time (at).

:::note

Reports are delivered instantly but the data has a one-hour lag for the production environment and eight-hour delay in sandbox. For example, a report requested at 9:00 AM will include transactions only up to 8:00 AM.

:::

See the Receive Transactions Report via Webhook guide for more information.

post/ledger/v1/reports

Request

Request body

walletIdstring

Wallet Id for which to retrieve transactions. If left blank, all transactions will be included in the report.

fromstring date-time

Initial date of the period being reported on in the ISO format. Required for TRANSACTION reports.

tostring date-time

Final date of the period in the ISO format. Required for TRANSACTION reports.

atstring date-time

Point-in-time date for the report in the ISO format. Required for BALANCE reports.

format'JSON' | 'CSV' | 'PDF'

Format of the report file.

deliveryChannel'EMAIL' | 'WEBHOOK'

Method of delivery for the report.

type'TRANSACTION' | 'BALANCE'

Report type. Use TRANSACTION for a transactions report over a date range, or BALANCE for a point-in-time balance snapshot.

Example request

{
  "walletId": "a:24092328494070:G5i4XZ9:1",
  "from": "2023-01-15T10:30:00Z",
  "to": "2025-12-15T10:30:00Z",
  "at": "2026-05-10T23:59:59",
  "format": "JSON",
  "deliveryChannel": "EMAIL",
  "type": "TRANSACTION"
}

Response

PROCESSING

idinteger

The ID of the transaction request.

uuidstring

The UUID of the transaction report.

dateCreatedinteger

The date and time, encoded into UNIX epoch timestamps.

lastUpdatedinteger

The date and time, encoded into UNIX epoch timestamps.

expiryDateinteger

The date and time, encoded into UNIX epoch timestamps.

statusstring

The status of the transaction report. A report normally moves through PENDING, PROCESSING, READY, and SENT.

  • PENDING: The report request is queued.

  • PROCESSING: The report is being generated.

  • READY: The report is generated and ready for download.

  • SENT: The report has been delivered through the requested delivery channel.

  • FAILED: The report could not be generated.

  • FALLBACK: The requested period is before 2023-12-01, so the request is handled by the legacy report.

typestring

The type of the report.

Example response

[
  {
    "id": 594,
    "uuid": "9d1f67f2-a647-404b-9b02-247c77be81d0",
    "dateCreated": 1631619489000,
    "lastUpdated": 1631619489000,
    "expiryDate": 1631619489000,
    "status": "PENDING",
    "type": "transactions",
    "requestData": {
      "type": "transactions",
      "externalProcessing": "null",
      "walletId": "a:24092328494070:G5i4XZ9:1",
      "transactionType": "null",
      "fromDate": "2023-03-01",
      "toDate": "2023-06-30",
      "format": "CSV",
      "languageTag": "en-US",
      "accountName": "null"
    }
  }
]

Changes

  • 97d6c0d2fe2eRevision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new optional request property

    • info

      added the new BALANCE enum value to the request property

    • info

      added the new TRANSACTION enum value to the request property