Integration GuideAPI Reference
Integration Guide

Disbursement: Get Payout Balance

Related API Reference

Get Payout Balance →

Overview

Before creating a disbursement, you can retrieve the current payout balance for your Settlement Account.

The API returns the DISBURSEMENT balance for each currency configured on your account. Use it to check whether sufficient funds are available for an intended payout.

📘

Retrieving the payout balance is optional.

The returned balance is informational. It does not reserve funds or guarantee that a subsequent disbursement will be accepted.

Amounts and currencies

  • disbursementBalance is a decimal amount in the currency's major unit — not an integer in minor units.

    API10 USD is represented as
    This API10.00
    Some other systems1000 (minor units, e.g. cents)
  • currencyCode is a 3–5 character code: ISO 4217 alpha-3 for fiat currencies (e.g. USD, EUR, RUB).

  • Balances are scoped per currency. When a currency is enabled on your Settlement Account, all balance categories — including DISBURSEMENT — are created automatically for it, even if you don't use payouts yet. In that case, disbursementBalance will simply be 0.

  • If no currencies are configured on your Settlement Account yet, the response returns 200 OK with an empty currencies array — this is different from a 404, which means the Settlement Account itself has no balance record at all.

Payout balance vs. payment balance

Your payout balance is isolated from the balance that accumulates from received payments. Funds collected via Pay-in are not automatically available for payouts — the DISBURSEMENT balance is funded separately. This separation is intentional: it prevents processed payment volume from being mistaken for withdrawable/payout funds.

Negative balance

Depending on your contract terms, your account may be configured to allow the DISBURSEMENT balance to go negative up to a set limit. If a disbursement would exceed that limit, the disbursement is declined.

Fees

When checking whether your balance covers an intended payout, account for the fee as well as the payout amount:

transaction amount 1,000 + fee 150 = total deduction from DISBURSEMENT balance: 1,150

Foreign exchange

The DISBURSEMENT balance is checked and debited in the submitted currency (the currency you send in the disbursement request), regardless of the currency ultimately paid out to the recipient. For example, if you submit a payout in RUB but the recipient is paid in IDR, your RUB DISBURSEMENT balance is what gets checked and debited — the FX conversion happens downstream, on the payout execution side.

How It Works

  1. (Optional) Retrieve the payout balances for your Settlement Account.
  2. Select the balance for the intended payout currency.
  3. Check that it covers the payout amount plus the applicable fee.
  4. Create the disbursement.
  5. Track its status using Disbursement: Get Details.
⚠️

The balance may change between retrieving it and submitting the disbursement.

This endpoint is read-only and does not reserve funds. Sufficiency of funds is only finally verified when the disbursement is created.

How this differs from "Check is Disbursement Possible"

Check is Disbursement Possible validates whether a disbursement is structurally eligible — the transaction route, partner, and payment method for the given parameters. It does not check whether you have sufficient funds.

Get Payout Balance tells you how much you currently have available. Neither call guarantees that a subsequent disbursement will succeed — funds sufficiency is enforced only at the point the disbursement is actually created.



Did this page help you?