LogoLogo
  • Overview
  • Authentication
  • Error Codes
  • Payout API
    • Receiver
      • Create New Receiver
      • KYC Verification for Payout
      • Add Receiver Account
        • International
          • Virtual Card
        • Australia (AUD)
          • Direct Entry
        • Canada (CAD)
          • EFT
          • Digital Payment
        • Europe (EUR)
          • SEPA
        • New Zealand (NZD)
          • Direct Credit
        • United States of America (USD)
          • ACH
      • Get Receiver
      • Get Receiver Bank Account
      • Webhooks
    • Payout
      • Create a Payout Transaction
      • Get Payout
      • Webhooks
      • Sandbox Test Helper
    • Balance
      • Get Account Balance
    • Account
      • Get Current Account
      • Webhooks
    • Batch
      • Webhooks
Powered by GitBook
LogoLogo

© 2025 Ipay Technologies Pty Ltd

On this page
Export as PDF
  1. Payout API
  2. Balance

Get Account Balance

Get SubAccount Balance

GET /api/subaccount/balance/<subaccount_id>

Get asset balance of currently subaccount user.

Headers

Name
Value

x-api-key

<token>

signature

<token>

Request query parameter

Name
Type
Description

asset*

string

Asset to get balance

* is mandatory parameter

Example query parameter request

/api/subaccount/balance/3dc81811-8cdb-49c6-8f9e-9125ea4540b0?asset=aud

Response

{
    "message": "balance found",
    "payload": {
        "available": 958638,
        "pending": 17526,
        "asset": "AUD"
    }
}
{
    "message": "Get balance failed",
    "error": [
        {
            "code": "SUBA304",
            "message": "Asset is not valid"
        }
    ]
}
PreviousBalanceNextAccount

Last updated 11 months ago