Skip to main content
GET
/
account
/
balance
curl -X GET 'https://api.goatpay.com.br/v1/account/balance' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Saldo consultado com sucesso",
  "data": {
    "currency": "BRL",
    "availableAmount": 1000,
    "pendingAmount": 0,
    "livre": { "available": 0, "pending": 0 },
    "padrao": { "available": 1000, "pending": 0, "withdrawable": 1000, "locked24h": 0, "nextUnlockAt": null }
  },
  "requestId": "req_abc"
}

curl -X GET 'https://api.goatpay.com.br/v1/account/balance' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Saldo consultado com sucesso",
  "data": {
    "currency": "BRL",
    "availableAmount": 1000,
    "pendingAmount": 0,
    "livre": { "available": 0, "pending": 0 },
    "padrao": { "available": 1000, "pending": 0, "withdrawable": 1000, "locked24h": 0, "nextUnlockAt": null }
  },
  "requestId": "req_abc"
}

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Response

Saldo da conta.

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string