1. Customer Accounts
Almara Pay Documentation
  • Introduction
  • Definitions
    • Data Types
    • Error Codes
    • MCCMNC Codes
  • Authorization
    • Overview
    • Token Request
      POST
    • Find Transaction Routes
      GET
    • Health Check
      GET
  • Payouts
    • Overview
    • Payment Order Request Information
    • Mobile Money Requests
      • Overview
      • Mobile Transfers- Safaricom (M-Pesa)
      • Mobile Transfers - Airtel Money
    • Payment Order Requests - Business Transfers
      POST
    • Payment Order Requests - Bank Transfers
      POST
    • Find Payment Order By OriginatorConversationId
      GET
    • Reject Order By OriginatorConversationId
      POST
  • Pay-Ins
    • Payment Links
      • Overview
      • Create Payment Link
      • Find Payment Links By Id
      • Update Payment Link
    • Express Deposits
      • Overview
      • Express Deposit Request
      • Find Express Deposit By OriginatorConversationId
    • C2B IPN (Callback)
      • C2B IPN Overview
  • Card Payments
    • Overview
    • Checkout Order Request
      POST
    • Query Checkout Request
      GET
    • Checkout Callback Request
      POST
  • Account Validation
    • Overview
    • Account Number Validation Request
    • Find KYC Status by SystemTraceAuditNumber
    • Account Validation
    • Find Account Validation Status by SystemTraceAuditNumber
  • Platform Services
    • Airtime Purchase
      • Overview
      • Airtime Purchase
      • Find Airtime Purchases By OriginatorConversationId
    • Customer Accounts
      • Balance Check
        GET
      • Find Charges By TransactionTypeId
        GET
    • Bill Payments
      • Overview
      • Bill Request Validation
      • Bill Request Payment
      • Find Bill Services
      • Find Bill Number By Service Id and Account Number
      • Find Bill Request By Originator Converstion Id
      • Bill Number
  1. Customer Accounts

Balance Check

GET
/v1/customer-accounts/get-wallet-balance
This request allows you to retrieve your total balance and balance information from your wallet.
Note: A valid token is required for authentication as it expires after every hour. Refer to Token Request to generate a new token.
Pass the ccy (currency code) as a Query Param

Request

Authorization
Query Params

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/customer-accounts/get-wallet-balance?ccy=404'
Response Response Example
{
    "customerAccountBalanceList": [
        {
            "status": "00",
            "message": null,
            "balance": 0.0,
            "type": 0
        },
        {
            "status": "00",
            "message": null,
            "balance": 0.0,
            "type": 0
        },
        {
            "status": "00",
            "message": null,
            "balance": 0.0,
            "type": 0
        },
        {
            "status": "00",
            "message": null,
            "balance": 0.0,
            "type": 0
        }
    ],
    "status": "00",
    "balance": 0.0
}
Modified at 2026-04-30 05:53:25
Previous
Find Airtime Purchases By OriginatorConversationId
Next
Find Charges By TransactionTypeId
Built with