Skip to main content
POST
/
wallet
/
account-statement
curl -X POST "https://demo.api.vultlocal.com/api/v1/wallet/account-statement" \
  -H "Authorization: Bearer olive_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "subscriber_id": "sub_abc123",
    "pin": "1234",
    "from_date": "2025-01-01",
    "to_date": "2025-01-31",
    "format": "pdf"
  }'

{
  "success": true,
  "message": "Statement generated successfully",
  "statement_url": "https://storage.olive.example.com/statements/stmt_abc123.pdf",
  "transaction_count": 45,
  "period": {
    "from": "2025-01-01",
    "to": "2025-01-31"
  },
  "opening_balance": "50,000.00 SLE",
  "closing_balance": "125,000.00 SLE",
  "expires_at": "2025-02-01T10:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vultlocal.com/llms.txt

Use this file to discover all available pages before exploring further.

Generate downloadable account statements in PDF or CSV format for a specified date range.

​
Request

​
Authorization
string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)

​
Body Parameters

​
subscriber_id
string
required
Subscriber UUID
​
pin
string
required
Subscriber’s 4-digit PIN
​
from_date
string
required
Start date (YYYY-MM-DD)
​
to_date
string
required
End date (YYYY-MM-DD)
​
format
string
default:"pdf"
Output format: pdf or csv

​
Response

​
success
boolean
Whether generation succeeded
​
statement_url
string
Download URL (valid for 24 hours)
​
transaction_count
integer
Number of transactions in statement

​
Examples

curl -X POST "https://demo.api.vultlocal.com/api/v1/wallet/account-statement" \
  -H "Authorization: Bearer olive_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "subscriber_id": "sub_abc123",
    "pin": "1234",
    "from_date": "2025-01-01",
    "to_date": "2025-01-31",
    "format": "pdf"
  }'

{
  "success": true,
  "message": "Statement generated successfully",
  "statement_url": "https://storage.olive.example.com/statements/stmt_abc123.pdf",
  "transaction_count": 45,
  "period": {
    "from": "2025-01-01",
    "to": "2025-01-31"
  },
  "opening_balance": "50,000.00 SLE",
  "closing_balance": "125,000.00 SLE",
  "expires_at": "2025-02-01T10:30:00Z"
}

​
Statement Contents

Professional statement including:
  • Account holder details
  • Opening/closing balance
  • Transaction table with dates
  • Running balance column
  • Summary totals

​
Date Range Limits

PeriodMaximum Range
Standard90 days
Premium365 days
CorporateUnlimited
Statement URLs expire after 24 hours. Download or share immediately.

​
Errors

StatusCodeDescription
400INVALID_DATE_RANGEInvalid or excessive date range
400INVALID_FORMATFormat must be pdf or csv
400INVALID_PINPIN verification failed
401UNAUTHORIZEDInvalid API key
404SUBSCRIBER_NOT_FOUNDSubscriber not found
500GENERATION_FAILEDStatement generation error

Authorizations

​
Authorization
string
header
required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Body

application/json

Account statement request

​
end_date
string
required
Example:

"2025-11-08"

​
start_date
string
required
Example:

"2025-10-01"

​
subscriber_id
string
required
Example:

"subscriber-uuid"

Response

Statement data for PDF generation

The response is of type object.