Docs
get https://betpay.iugu.com/api/v1/balance

Retorna o saldo do workspace.

Retorna o saldo atual do workspace.

Permissão necessária: betpay:balance.read

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Headers

WORKSPACE_ID

Type: string

ID do workspace

Ex: 1D81KhKbYuVq9505Bz4Nk9

Response

200

Saldo retornado com sucesso

balance
Number

Saldo atual do workspace

Ex: 1000.0

moment
String

Momento da consulta do saldo

Ex: 2025-03-14T12:00:00Z

Example
1
2
3
4
{
  "balance": 1000.0,
  "moment": "2025-03-14T12:00:00Z"
}