Skip to main content
GET
Node.js
Required scope: balances:read Requires balances:read. Exact balances remain in their original currencies; USD values are indicative estimates, not a quote or permission to pay. valuationStatus=partial means some balances could not be valued: null totals are unavailable, not zero, and valuedSubtotalUsd covers only valued balances. Estimates cover the selected profile. payoutAllowance is shared by profiles belonging to the same business; it shows the per-payment cap, monthly usage, reservations, remaining allowance and reset time. Null limits mean unlimited; zero prevents new positive payouts when enforcementEnabled is true. enforcementEnabled tells you whether these USD limits are currently applied. Payment creation checks current balance, allowance and eligibility again. Responses use Cache-Control: private, no-store.

Authorizations

Authorization
string
header
required

A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.

Headers

X-Request-ID
string
x-ledig-business-id
string

The business whose balances you are authorised to view.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$
x-ledig-acting-business-id
string

Your institution when acting for a managed business. It must match your credentials; use HMAC v2.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$
x-ledig-profile-id
string

The profile whose balances you are authorised to view. Profiles in the same business share its payout allowance.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,199}$

Response

Your estimated USD balances and current payout allowance.

status
string
required
Allowed value: "success"
data
object
required