This web service enables the merchant to retrieve the full set of transactions on a particular account based on a specified date range.
BODY PARAMS
Parameter |
Data Type |
Description |
Required |
acc_no |
alphanumeric |
Wallet account number assigned by Lemonade Payment |
Y |
from_date |
date |
Start date of the statement period in ISO 8601 Date Format 'YYYY-MM-DD' |
Y |
to_date |
date |
End date of the statement date range in ISO 8601 date format 'YYYY-MM-DD' |
Y |
limit |
numeric |
Maximum number of transactions that can be returned in a response. Maximum allowed is 5,000 records |
Y |
HEADER PARAMS
Parameter |
Data Type |
Description |
Required |
Authorization |
alphanumeric |
bearer token used to access the API |
Y |
200 Success Response Schema
Parameter |
Data Type |
Description |
success |
bool |
Response bool |
message |
string |
Response message. |
data |
array |
transactions list |
data.type |
string |
transactions type |
data.amount |
numeric |
transactions amount |
data.balance |
numeric |
running balance amount |
data.description |
string |
transactions description |
data.created_at |
date |
transactions date |
Example Request
curl --location 'https://here-prod-api-url.com/api/v2/wallet/statement' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: ••••••' \
--data '{
"acc_no":"6670832229",
"from_date":"2024-06-25",
"to_date":"2024-12-31",
"limit":10
}'
Example Response
{
"success": true,
"message": "Successfully fetched",
"data": [
{
"type": "deposit",
"amount": "100",
"balance": 100,
"confirmed": true,
"date": "2024-06-24 13:22:28"
},
{
"type": "deposit",
"amount": "1",
"balance": 101,
"confirmed": true,
"date": "2024-06-25 16:10:59"
},
{
"type": "deposit",
"amount": "1",
"balance": 102,
"confirmed": true,
"date": "2024-07-02 12:02:02"
},
{
"type": "withdraw",
"amount": "-50",
"balance": 52,
"confirmed": true,
"date": "2024-07-02 12:03:46"
},
{
"type": "withdraw",
"amount": "-4",
"balance": 48,
"confirmed": true,
"date": "2024-07-02 12:03:57"
},
{
"type": "deposit",
"amount": "1",
"balance": 49,
"confirmed": true,
"date": "2024-07-02 13:01:04"
},
{
"type": "deposit",
"amount": "1",
"balance": 50,
"confirmed": true,
"date": "2024-07-02 13:08:20"
},
{
"type": "deposit",
"amount": "1",
"balance": 51,
"confirmed": true,
"date": "2024-07-02 14:48:09"
},
{
"type": "deposit",
"amount": "1",
"balance": 52,
"confirmed": true,
"date": "2024-07-02 14:54:28"
},
{
"type": "deposit",
"amount": "1",
"balance": 53,
"confirmed": true,
"date": "2024-07-02 14:56:13"
},
{
"type": "deposit",
"amount": "1",
"balance": 54,
"confirmed": true,
"date": "2024-07-02 14:57:49"
},
{
"type": "deposit",
"amount": "1",
"balance": 55,
"confirmed": true,
"date": "2024-07-02 15:02:16"
},
{
"type": "deposit",
"amount": "1",
"balance": 56,
"confirmed": true,
"date": "2024-07-02 15:08:32"
},
{
"type": "deposit",
"amount": "1",
"balance": 57,
"confirmed": true,
"date": "2024-07-02 15:10:17"
},
{
"type": "deposit",
"amount": "1",
"balance": 58,
"confirmed": true,
"date": "2024-07-03 17:00:54"
},
{
"type": "deposit",
"amount": "10",
"balance": 68,
"confirmed": true,
"date": "2024-07-05 10:51:36"
},
{
"type": "withdraw",
"amount": "-50",
"balance": 18,
"confirmed": true,
"date": "2024-07-05 10:52:52"
},
{
"type": "withdraw",
"amount": "-4",
"balance": 14,
"confirmed": true,
"date": "2024-07-05 10:53:01"
}
]
}