Ctrl K
Wallet Accrued Interest
GET/api/v1/wallet/interests/accrued/:wallet_id
Returns the paginated list of stored interest accruals for a wallet.
Historical Interest (date range)
Point this endpoint at any date window by passing start_date and end_date. If both are omitted the response defaults to the current calendar month.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| wallet_id | string | Yes | Wallet id. |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| start_date | string | No | Start of accrual filter. If omitted, defaults to start of current calendar month. |
| end_date | string | No | End of accrual filter. If omitted, defaults to end of current calendar month. |
| limit | number | No | Page size; default 31, maximum 100. |
| cursor | string | No | Pagination cursor on interest_date_timestamp. |
| interest_type | string | No | "original" (default) or "differential". |
| search | string | No | Case-insensitive filter on differential wallet name when applicable. |
1
Request Example
(cURL)
curl -X GET "https://api.piggyvest.business/api/v1/wallet/interests/accrued/{wallet_id}" \-H "Authorization: Bearer YOUR_SECRET_KEY"2
Success Response(200)
(JSON)
{ "status": true, "message": "Fetched wallet interest accrual", "data": { "paginatedPayload": { "edges": [ { "id": "string", "business_id": "string", "wallet_id": "string", "wallet_name": "string", "amount": 0, "balance": 0, "percentage": 0, "interest_date": "string", "interest_date_timestamp": "string", "interest_type": "original | differential", "differential_wallet_id": "string | null", "differential_wallet_name": "string | null", "created_at": "string", "updated_at": "string" } ], "pageInfo": { "hasNextPage": true, "endCursor": "string | null", "previousCursor": "string | null" } } }}Interest Forfeiture
Customers who perform more than 4 withdrawals within a month become ineligible for interest pay-out for that month. The withdrawal count resets at the start of each month.
Withdrawals include:
- Bank Transfer (Outflow)
Interest Pay-out Timing
- Interest accrues daily
- Interest pay-out occurs on the first day of every month
- Interest pay-out represents accrued interest from the previous month
Example: Interest earned during January is paid on February 1st.