The wallet statement resource allows you to generate detailed transaction statements for your wallets over a specified time period.
Statements provide a comprehensive view of all wallet activity, including payouts, collections, and currency conversions, along with opening and closing balances.
ℹ️ Lifecycle
When you submit a request to create a statement, our server validates the request and accepts it for processing. The statement generation is handled asynchronously, and an HTTP 202 status code is returned along with the statement unique identifier.
Upon acceptance, the statement is marked as PENDING. Your client program will need to poll at intervals to query the statement state and determine whether it has completed processing. After the statement is completed, provided webhook notifications are set up, Rafiki will also dispatch wallet-statement.state-updated event.
Statement States
| State | Description |
|---|---|
| ⏳ PENDING |
Your statement request has been accepted, and it is currently being generated. |
| ✅ READY |
The statement has been successfully generated and is ready to be retrieved. You can now list the statement lines. |
| 💔 FAILED |
The statement generation failed. Please contact support if this persists. |
📅 Period Requirements
The from and to fields in the period must be valid dates or RFC3339 datetime strings with hour precision. This means:
- Dates like
2025-01-01are valid (interpreted as2025-01-01T00:00:00Z) - Datetimes like
2025-01-01T00:00:00Zor2025-01-31T23:00:00Zare valid - Datetimes with minutes or seconds other than
00(e.g.,2025-01-01T00:30:00Z) are not valid
The from date must be before the to date.