Skip to main content
GET
/
subaccount
/
balance
curl -X GET 'https://api.goatpay.com.br/v1/subaccount/balance?externalReference=loja-parceiro-a' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Saldo da subconta",
  "data": {
    "id": "clx_subconta",
    "balance": {
      "availableWhite": 1500,
      "pendingWhite": 0,
      "lockedWhite": 0,
      "spendableWhite": 1500
    }
  },
  "requestId": "req_abc123"
}

curl -X GET 'https://api.goatpay.com.br/v1/subaccount/balance?externalReference=loja-parceiro-a' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Saldo da subconta",
  "data": {
    "id": "clx_subconta",
    "balance": {
      "availableWhite": 1500,
      "pendingWhite": 0,
      "lockedWhite": 0,
      "spendableWhite": 1500
    }
  },
  "requestId": "req_abc123"
}
​
id
string
ID da subconta. Informe id ou externalReference.
​
externalReference
string
Referência externa da subconta.

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

​
id
string
​
externalReference
string

Response

200 - application/json

Operação concluída.

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Pagamento PIX criado com sucesso"

​
data
object
required
​
requestId
string