---
updatedAt: 2026-04-23T04:16:37.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# account/balance

This endpoint returns details on your current account balance and available funds.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0",
    "title": "Accounts",
    "description": "The Account API defines endpoints for managing VoPay accounts and sub-accounts.  These endpoints allow partners to create and manage accounts, set permissions, handle transactions,  schedule transfers, retrieve account information, and manage onboarding processes, ensuring secure  and efficient account and transaction management.",
    "contact": {
      "name": "API Support",
      "email": "help@vopay.com"
    }
  },
  "paths": {
    "/account/balance": {
      "get": {
        "description": "This endpoint returns details on your current account balance and available funds.",
        "summary": "account/balance",
        "tags": [
          "Account Endpoints"
        ],
        "operationId": "AccountBalanceGet",
        "deprecated": false,
        "parameters": [
          {
            "name": "AccountID",
            "in": "query",
            "required": true,
            "description": "Your account ID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Key",
            "in": "query",
            "required": true,
            "description": "API key for the account",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Signature",
            "in": "query",
            "required": true,
            "description": "Hashed signature for the request",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Currency",
            "in": "query",
            "required": false,
            "description": "3 character currency code for the currency to fetch transactions for. If this is not specified it will be defaulted to the account's local currency (generally CAD).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "AsOfDate",
            "in": "query",
            "required": false,
            "description": "A date in ISO 8601 format (yyyy-mm-dd) representing the date for which you want to retrieve the balance. If not provided, the current balance will be returned.",
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "Success": {
                      "type": "boolean",
                      "description": "True if the request was successful, false if it failed",
                      "example": true
                    },
                    "ErrorMessage": {
                      "type": "string",
                      "description": "Contains a description of the error if the request failed",
                      "example": ""
                    },
                    "AccountBalance": {
                      "type": "number",
                      "description": "Indicates the total current account balance, including pending funds.",
                      "example": "20000.00"
                    },
                    "PendingFunds": {
                      "type": "number",
                      "description": "Indicates the portion of the account balance which is pending due to in-progress transactions.",
                      "example": "5540.24"
                    },
                    "Reserve": {
                      "type": "number",
                      "description": "Indicates the portion of the account balance which is being held as a reserve against negative balances.",
                      "example": "50000.00"
                    },
                    "RollingReserveNSF": {
                      "type": "number",
                      "description": "Indicates the portion of the account balance which is being held as a reserve against NSF transactions.",
                      "example": "10000.00",
                      "x-absent-when": "account has no rolling reserve"
                    },
                    "RollingReserveReturns": {
                      "type": "number",
                      "description": "Indicates the portion of the account balance which is being held as a reserve against returned transactions.",
                      "example": "1000.00",
                      "x-absent-when": "account has no rolling reserve"
                    },
                    "AvailableImmediately": {
                      "type": "number",
                      "description": "Indicate the portion of the account balance that is available immediately",
                      "example": "0.00"
                    },
                    "AvailableFunds": {
                      "type": "number",
                      "description": "Indicates the portion of the account balance which is currently available for use. This is calculated by taking the AccountBalance and subtracting the PendingFunds, Reserve, RollingReserveNSF and RollingReserveReturns amounts.",
                      "example": "18000.00"
                    },
                    "Currency": {
                      "type": "string",
                      "description": "3 character currency code for the balance being returned.",
                      "example": "CAD"
                    },
                    "AsOfDate": {
                      "type": "string",
                      "format": "date",
                      "description": "The date for which the balance is being returned.",
                      "example": "2020-01-01"
                    },
                    "RollupAvailableBalance": {
                      "type": "string",
                      "description": "Represents the aggregated total available balance of all sub-accounts under this account. This is only returned if the account has sub-accounts enabled.",
                      "example": "1280000.00",
                      "x-absent-when": "SubAccountPermissions disabled"
                    },
                    "RollupAccountBalance": {
                      "type": "string",
                      "description": "Represents the aggregated total account balance of all sub-accounts under this account. This is only returned if the account has sub-accounts enabled",
                      "example": "18000.00",
                      "x-absent-when": "SubAccountPermissions disabled"
                    }
                  },
                  "required": [
                    "Success",
                    "ErrorMessage",
                    "AccountBalance",
                    "PendingFunds",
                    "Reserve",
                    "AvailableImmediately",
                    "AvailableFunds",
                    "Currency",
                    "AsOfDate"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ]
}
```