Mercury - Get Balance

Description

This module allows getting the current and available balance of Mercury accounts. It can query a specific account or the consolidated balance of all accounts.

Configuration

Field	Type	Required	Description
credentials_id	credential	Yes	Mercury credentials
account_id	string	No	Specific account ID (empty = all)

Credentials

This module requires Mercury type credentials with the following fields:

Field	Description
api_key	Mercury API Key (obtained in Settings > API)

Output

Specific account balance

{
  "success": true,
  "account_id": "abc123",
  "name": "Operating Account",
  "type": "checking",
  "current_balance": 125000.00,
  "available_balance": 123500.00,
  "currency": "USD",
  "message": "Operating Account: $123500 disponible"
}

All accounts balance

{
  "success": true,
  "balances": [
    {
      "account_id": "abc123",
      "name": "Operating Account",
      "type": "checking",
      "current_balance": 125000.00,
      "available_balance": 123500.00
    },
    {
      "account_id": "def456",
      "name": "Savings",
      "type": "savings",
      "current_balance": 50000.00,
      "available_balance": 50000.00
    }
  ],
  "total_current_balance": 175000.00,
  "total_available_balance": 173500.00,
  "currency": "USD",
  "accounts_count": 2,
  "message": "Balance total: $173500 disponible en 2 cuentas"
}

Difference Between Balances

• current_balance: Total book balance
• available_balance: Available balance for use (may be less due to pending transfers or holds)

Usage Example

{
  "credentials_id": "mercury_cuenta",
  "account_id": ""
}

API Used

• API: Mercury API v1
• Endpoint: GET /api/v1/accounts
• Documentation: https://docs.mercury.com/reference

Use Cases

1. Liquidity monitoring: Verify available funds before payments
2. Low balance alerts: Notify when balance falls below a threshold
3. Financial reports: Consolidate balances from multiple accounts
4. Treasury automation: Transfer funds between accounts based on rules

Notes

• current_balance is the total book balance
• available_balance may be less due to pending transfers
• If no account_id is specified, balances for all accounts are returned

Related Nodes

• MercuryGetAccounts - Get complete account details
• MercuryCreateTransfer - Create transfers verifying funds
• MercuryGetTransactions - View movements affecting the balance