> ## Documentation Index > Fetch the complete documentation index at: https://docs.dimepayments.com/llms.txt > Use this file to discover all available pages before exploring further. # Get held balance > The merchant's current balance at the processor, and how much of it is releasable today. Only available for merchants on a fund-holding tier. Everyone else has no held balance by definition — their money sweeps automatically — and this returns 422 rather than a misleading zero. `releasable` is the figure to pay attention to, and the one a release is checked against. It is `available` less four things: - `at_risk` — ACH payments that have funded but are still inside the settlement window, where the customer's bank can return the debit. Clears by waiting; `ach_settlement_days` says how long. - `owed_to_split` — a share of takings already promised to another account and not yet moved. Clears tonight, without anyone acting. - `unresolved` — releases already requested and not yet confirmed. - `release_fee` — what the release itself will cost. ## OpenAPI ````yaml https://app.dimepayments.com/openapi.yaml get /api/funds/balance openapi: 3.0.3 info: title: Dime Payments API Documentation description: >- A simple, basic API for managing Merchants through Dime Payments. JSON based REST API version: 1.0.0 servers: - url: https://app.dimepayments.com security: - default: [] tags: - name: Merchant management description: '' - name: Transaction management description: >- APIs for managing transactions. Depending on API KEY permissions, one should be able to charge credit cards, ACH, Google/Apple Pay wallets along with other functions. - name: Chargeback management description: '' - name: Document management description: '' - name: Addresses description: |- APIs for managing customer addresses - name: Customer management description: >- APIs for managing customers. Depending on API KEY permissions, one should be able to list, create, update, and delete customers along with several other customer specific requests. - name: Deposit management description: '' - name: Held funds description: '' - name: Invoice management description: >- APIs for managing invoices. Depending on API KEY permissions, one should be able to list, create, update, delete, and send invoices, manage their line items, and manage recurring-invoice schedules. Every request is scoped to a single Merchant via the required `data.sid`. - name: Payment Method management description: >- APIs for managing payment methods associated with customers. Depending on API KEY permissions, one should be able to list, show, create, update, and delete payment methods. - name: Recurring Payments management description: >- APIs for managing recurring payments. Depending on API KEY permissions, one should be able to create, edit, pause, cancel along with other functions. - name: Subscription Plans management description: >- Merchant-facing API for subscription plans (recurring offerings customers subscribe to). The merchant is identified by `data.sid`; the token must carry the matching `subscription-plan:*` ability. Mirrors the recurring-payment and invoice API controllers. - name: Subscriptions management description: >- Merchant-facing API for individual customer subscriptions (enrollments in a plan). The merchant is identified by `data.sid`; the token must carry the matching `subscription:*` ability. Lifecycle transitions delegate to the {@see \App\Actions\Subscription} action classes so the matching `SUBSCRIPTION_*` webhook always fires. Mirrors the recurring-payment and subscription-plan API controllers. - name: Zapier description: >- APIs for use through Zapier. Depending on API KEY permissions, one should be able to see customers and transactions data. paths: /api/funds/balance: get: tags: - Held funds summary: Get held balance description: >- The merchant's current balance at the processor, and how much of it is releasable today. Only available for merchants on a fund-holding tier. Everyone else has no held balance by definition — their money sweeps automatically — and this returns 422 rather than a misleading zero. `releasable` is the figure to pay attention to, and the one a release is checked against. It is `available` less four things: - `at_risk` — ACH payments that have funded but are still inside the settlement window, where the customer's bank can return the debit. Clears by waiting; `ach_settlement_days` says how long. - `owed_to_split` — a share of takings already promised to another account and not yet moved. Clears tonight, without anyone acting. - `unresolved` — releases already requested and not yet confirmed. - `release_fee` — what the release itself will cost. operationId: getHeldBalance parameters: [] requestBody: required: false content: application/json: schema: type: object properties: data: type: object description: '' example: [] properties: sid: type: string description: The ID of the merchant. example: '91828382' required: - sid responses: '200': description: Success content: application/json: schema: type: object example: data: sid: '91828382' available: 6492.87 pending: 0 reserve: 0 at_risk: 1250 owed_to_split: 40.15 unresolved: 0 release_fee: 30 releasable: 5172.72 ach_settlement_days: 7 ach_out_enabled: true ach_out_limit_remaining: 19999999.99 properties: data: type: object properties: sid: type: string example: '91828382' available: type: number example: 6492.87 description: >- Balance the processor will let us move today, in dollars. pending: type: integer example: 0 description: >- Money received but not yet cleared into the available balance. reserve: type: integer example: 0 description: Balance the processor is holding back as reserve. at_risk: type: integer example: 1250 description: >- ACH payments inside the settlement window, included in `available` but not safe to release. owed_to_split: type: number example: 40.15 description: >- Takings already promised to another account and not yet moved. Included in `available`, not releasable. unresolved: type: integer example: 0 description: >- Releases requested and not yet confirmed. Held back until they are, so nothing can be sent twice. release_fee: type: integer example: 30 description: >- What each release costs, in dollars. Held back from `releasable` so a release of the whole figure cannot overdraw the account. releasable: type: number example: 5172.72 description: >- What you can actually release right now: `available` minus `at_risk`, `owed_to_split`, `unresolved` and `release_fee`, never below zero and never above `ach_out_limit_remaining`. Zero when transfers out are disabled. ach_settlement_days: type: integer example: 7 description: >- How many days an ACH payment is held before it counts as settled. ach_out_enabled: type: boolean example: true description: >- Whether the processor currently permits transfers out of this account. ach_out_limit_remaining: type: number example: 19999999.99 description: >- Remaining transfer-out headroom at the processor, in dollars. '401': description: '' content: application/json: schema: oneOf: - description: Incorrect API Key Permission type: object example: data: message: Permission Denied. properties: data: type: object properties: message: type: string example: Permission Denied. - description: Not associated with Affiliate type: object example: data: message: Not associated with Affiliate properties: data: type: object properties: message: type: string example: Not associated with Affiliate '404': description: Unknown merchant content: application/json: schema: type: object example: data: message: No such Merchant properties: data: type: object properties: message: type: string example: No such Merchant '422': description: Merchant does not hold funds content: application/json: schema: type: object example: data: message: >- This merchant's funds are not held; they settle automatically. properties: data: type: object properties: message: type: string example: >- This merchant's funds are not held; they settle automatically. '503': description: Processor unreachable content: application/json: schema: type: object example: data: message: The processor could not be reached. Try again shortly. properties: data: type: object properties: message: type: string example: The processor could not be reached. Try again shortly. components: securitySchemes: default: type: http scheme: bearer description: >- You can retrieve your token by visiting your dashboard and clicking Generate API token under your profile in top right. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.