Skip to main content
GET
Node.js
Required scope: balances:read Returns a zero balance if your business has not held this currency before, so you can check it before your first deposit. Amounts are returned as decimal strings.

Authorizations

x-ledig-key
string
header
required

Your business API key ID. Keep its secret on your server and use that secret to sign each request.

x-ledig-timestamp
string
header
required

The current Unix timestamp in seconds, used in the signed request.

x-ledig-signature
string
header
required

The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.

Path Parameters

currency
string
required

A currency code, such as USD. Lowercase input is converted to uppercase.

Response

Balance.

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

Your business's available and reserved funds in one currency.

message
string