v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Get Balance History

This endpoint fetches all pay-ins and pay-outs that occurred on your integration

get/wallets/logs

Request body

businessstring required

The unique Identifier of the parent business or sub account

actionstring

This means debit or credit e.g debit/credit

dateFromstring

The start date.This must be in ISO 8601 date format(YYYY-MM-DD)

dateTostring

The end date.This must be in ISO 8601 date format(YYYY-MM-DD)

pagestring

Specify exactly what page you want to retrieve

perPagestring

How many records page you want to retrieve per page

amountstring

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Wallet logs fetched successfully",
  "data": {
    "results": [
      {
        "id": 118199,
        "reference": "a3bba51f-7a79-4e2f-a2fd-27e8d4c589db",
        "createdAt": "2024-07-16T15:05:42.000Z",
        "description": "collection successful",
        "action": "credit",
        "amount": 140000,
        "currency": "USD",
        "method": "Manual Top up",
        "reason": "collections",
        "availableBalanceBefore": 200,
        "availableBalanceAfter": 140200,
        "ledgerBalanceBefore": 200,
        "ledgerBalanceAfter": 140200
      }
    ],
    "total": 192
  }
}