Balance

curl

examples/curl/payouts/get-balance.sh

#!/usr/bin/env bash
# The project's balance: available, pending, reserved, outgoing.
set -euo pipefail
. "$(dirname "$0")/../signed-request.sh"

mka_request GET "/v1/balance"

Node

examples/node/payouts/get-balance.mjs

// The project's balance: available, pending, reserved, outgoing.
import { print, request } from "../signed-request.mjs";

const answer = await request("GET", "/v1/balance");
print(answer);

PHP

examples/php/payouts/get-balance.php

<?php
// The project's balance: available, pending, reserved, outgoing.

declare(strict_types=1);

require __DIR__ . '/../signed_request.php';

mka_show(mka_request('GET', '/v1/balance'));

Python

examples/python/payouts/get_balance.py

"""The project's balance: available, pending, reserved, outgoing."""
from signed_request import request, show

show(request("GET", "/v1/balance"))

Go

examples/go/payouts/get-balance.go

//go:build ignore

// The project's balance: available, pending, reserved, outgoing.
package main

import (
  "docs.processing.yolotech.cc/examples/signedrequest"
)

func main() {
  signedrequest.Show(signedrequest.Request("GET", "/v1/balance", nil, ""))
}

One entry per currency — LKR — never converted or summed:

Figure	Holds
available	What payouts, refunds and withdrawals may spend now. Below zero only when a reserve was set after the money was spent.
pending	Succeeded payments not yet credited.
reserved	What the rolling reserve holds; next_release_at and next_release say when and how much comes back next. Already out of available.
outgoing	Open payouts with their fees, refunds and withdrawals. Already out of available.

A payout or a refund holds its money from available the moment you create it; a failed or cancelled one gives it back. Check available before a large payout to avoid 422 insufficient_available_balance.

These are the same figures as the console’s balance screen.