Balance

Retrieve your available and pending VINR account balance.

View as Markdown

The balance object shows the funds currently held in your VINR account, split into what is immediately available for payouts and what is still pending settlement. The balance updates automatically as payments are captured and payouts are initiated.

Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.

The balance objectAsk

availablearray

Funds that can be paid out immediately. Each entry represents a currency bucket.

pendingarray

Funds that have been received but are not yet available for payout (e.g. awaiting settlement). Each entry represents a currency bucket.

Retrieve the balanceAsk

The balance is a singleton — there is no ID and no list endpoint. A single GET returns the full breakdown across all currencies.

Was this page helpful?