1. Sub-Ledger
Fintainium APIs
  • Overview
  • Quick Start
  • Use Cases
  • Recipies
    • Connect with Vendor
    • Pay a Vendor
  • API Reference
    • AP Payouts (Accounts Payable)
      • Vendor (Recipient)
        • Create new vendor
        • Update Vendor
        • View Vendor Details
      • Payments (Payouts)
        • Initiate Payment
        • Add Payment Method
      • Bills
        • Create new Bill
      • Country State City
        • GET City List by State Name/ID/Code
    • AR Collection (Accounts Receivable)
      • Invoices
        • Create new Invoice
      • Customers
        • Create new customer
      • Payment (Collection)
        • Initiate Payment
        • Add Payment Method
    • Simplified Payouts
      • Send Payouts
    • Transactions
      • Retrieve Transaction Status
    • Webhooks
      • Register for an Event
      • Get Webhook Registration Status
    • Sub-Ledger
      • Retrieve Balance
        GET
  1. Sub-Ledger

Retrieve Balance

GET
https://staginggateway.fintainium.com/gateway/api/payouts/batch/getBalance
The Retrieve Balance API returns the current available balance for a Fintainium managed sub-ledger account linked to a business. Use this endpoint as a pre-check before initiating AP vendor payouts or AR settlements to ensure sufficient funds are available.

Key Features#

Retrieve real-time available balance for a business's sub-ledger account managed by Fintainium.
Acts as a pre-check before initiating payouts or collections.
Supports usage across AP (vendor payouts) and AR (customer settlements) workflows.
Returns balance amount, currency, and last-updated timestamp for reconciliation

Request

Query Params

Header Params

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://staginggateway.fintainium.com/gateway/api/payouts/batch/getBalance?businessId=undefined' \
--header 'sessionKey;'
Response Response Example
{
    "status": "SUCCESS",
    "businessId": "3686906",
    "realTimeBalance": "260.00",
    "timestamp": "2025-09-18T13:16:37.372941-04:00"
}
Modified at 2025-09-18 17:25:38
Previous
Get Webhook Registration Status
Built with