Skip to content

Check your balance

GET /v1/partners/balance

What you can pay out right now.


Permission	`read-gateway`
Answers	`200`

Request

GET /v1/partners/balance
Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx

Response

{
  "data": {
    "balance": "5000000.0000",
    "available": "4820000.0000",
    "pending": "180000.0000",
    "reserve": "0.0000",
    "advance_used": "0.0000",
    "transferable_to_members": "4820000.0000",
    "currency": "IDR"
  },
  "request_id": "req_…"
}

What the numbers mean

Field	Meaning
`balance`	Total amount currently owed to you after ledger movements
`available`	Amount you can pay out now; this is the figure checked by the payout guard
`pending`	Part of your balance that is not yet available for payout

All figures are read on one clock, and available + pending equals balance in the response. A payout for exactly available will not be refused for lack of funds, subject to the configured payout limits.

With a deposit

Three fields serve member transfers. Without a deposit, reserve and advance_used are zero and the identity above holds unchanged.

Field	Meaning
`reserve`	Your deposit: released money set aside to cover member transfers. Never paid out to a bank
`advance_used`	How much of the deposit is covering transfers against payments not released yet. Comes back by itself as they are released
`transferable_to_members`	What you can move to members now

available keeps its meaning and excludes the deposit. With a deposit, balance = available + (reserve − advance_used) + pending.

Next