Skip to main content
GET
Get account balance

Authorizations

Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Response

Balance retrieved.

balance
object
required

Account balance for the company associated with the API key. The four buckets available, frozen, and held are independent and additive — total = available + frozen + held.