Startbutton Product API
  • Startbutton API doc
    • Get Started
    • Accept Payments
    • Server-to-Server Integration
      • S2S Integration for Virtual Accounts
        • S2S Virtual account (NGN)
        • S2S Virtual account (GHS)
        • S2S EFT (ZAR)
      • S2S Integration for Mobile Money
        • S2S MoMo (KES and GHS)
        • S2S MoMo (TZS and UGX)
        • S2S MoMo (RWF)
        • S2S MoMo XOF and XAF
    • Re-charge Card
    • Subscriptions
    • Payment Links
    • Currency Conversion
    • Get Wallet Balance
    • Transfer
      • Bank List
    • Security Measures.
      • IP Whitelisting
    • Webhook
    • Transaction Status
    • Get FX Rate
    • Under and Overpayments
    • Refunds
      • Refund Transaction Status (TSQ)
    • Available Currencies
    • FAQs
  • Advanced Security
    • Signed Payload for Transfer Requests.
Powered by GitBook
On this page
  1. Startbutton API doc

Get Wallet Balance

With a single endpoint, you can get the wallet balances for all collection currencies enabled for your account.

Authorization
Set value to `Bearer SECRET_KEY`

Content-type

Set value to application/json

BaseUrls

PROD : https://api.startbutton.tech

DEV/ Staging: https://api-dev.startbutton.tech

GET {{baseurl}}/wallet

Once a call is initiated, we return your wallet balances across all currencies.

Sample response:

{
    "success": true,
    "message": "Wallet",
    "data": [
        {
            "_id": "****b082****09cac****",
            "currency": "GHS",
            "availableBalance": 9737980,
            "ledgerBalance": 11266337,
            "createdAt": "2023-07-31T18:06:19.011Z",
            "updatedAt": "2024-07-10T14:30:05.598Z",
            "__v": 0
        },
        {
            "_id": "****8e5a3****a6d*****",
            "currency": "KES",
            "availableBalance": 3842517,
            "ledgerBalance": 3659155,
            "createdAt": "2023-10-06T09:25:34.497Z",
            "updatedAt": "2024-07-01T11:26:24.370Z",
            "__v": 0
        },
        {
            "_id": "*****13e****43cd51****",
            "currency": "NGN",
            "availableBalance": 349701483,
            "ledgerBalance": 532922397,
            "createdAt": "2023-07-31T14:12:14.837Z",
            "updatedAt": "2024-07-21T14:44:00.680Z",
            "__v": 0
       }
    ]
}
PreviousCurrency ConversionNextTransfer

Last updated 2 months ago