Get Payout Balance

Returns what you can commit to new payouts, and the limits that apply to your account.

GET/api/payout/balance

Authentication

Scope: payouts:read

Authorization: Bearer <YOUR_PAYOUT_KEY>

Response Fields

{
  "currency": "USD",
  "limits": {
    "fee_per_payout": "0.50",
    "min_payout": "2.00",
    "max_payout": "500.00",
    "max_open_exposure": "5000.00",
    "max_pending_per_customer": 3
  },
  "matured": "1800.00",
  "available_for_new_commitments": "1240.00",
  "merchant_settlement_holds": "0.00",
  "customer_payout_holds": "50.50",
  "customer_payouts_settled": "509.50",
  "retained_target": "500.00",
  "estimated_next_settlement": "740.00"
}

Field	Description
limits	Your live fee and limits. Read them from here rather than hardcoding them
matured	Funds that have cleared and are owed to you, before any holds
available_for_new_commitments	What a new payout (amount + fee) can be created against
merchant_settlement_holds	Held for a settlement to you that is under way
customer_payout_holds	Committed to payouts that have not completed, including their fees. Released if they are cancelled or expire
customer_payouts_settled	Paid out to your customers so far, including fees
retained_target	The amount your administrator asked us to keep back from automatic settlement. It is not a cap on payouts
estimated_next_settlement	Estimated amount of your next settlement

If your balance cannot be calculated at that moment, the response is instead:

{ "currency": "USD", "available": null, "reason": "…" }

Creating a payout at that point returns balance_unavailable (409). Contact us if it persists.

Request Samples

curl -s https://luxfin.org/api/payout/balance \
  -H "Authorization: Bearer $PAYOUT_KEY"