BVbvnk
Wallets

Get report

Changed on

Retrieves a report by its ID, including its current status and a signed URL to download the report file.

Use this endpoint to poll for report completion instead of relying only on the bvnk:ledger:report:ready webhook. You get the report ID in the Generate report response and in the webhook payload.

get/ledger/v1/reports/{id}

Request

Path parameters

idstring uuid required
Example:9d1f67f2-a647-404b-9b02-247c77be81d0

Unique identifier of the report. Use the uuid returned when you generate the report, which is also the id in the bvnk:ledger:report:ready webhook payload.

Response

Report retrieved successfully

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.

urlstring uri

Signed URL to download the report file. Returned once the report is available.

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"
  },
  "url": "https://bvnk-staging-reports.s3.eu-west-1.amazonaws.com/transaction/9d1f67f2-a647-404b-9b02-247c77be81d0_3c8e5b1a-72f4-4d09-b6a1-5e0f9d2c47aa.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20261028T093510Z&X-Amz-SignedHeaders=host&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20261028%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Expires=604800&X-Amz-Signature=2f4a9c07d1b85e36a0c9e47b8d153f62a7e0b94c51d8f3a6e2b70c4d95a18f3e"
}

Changes