curl -X GET 'https://api.goatpay.com.br/v1/subaccount/get/clx_subconta' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Subconta",
"data": {
"id": "clx_subconta",
"name": "Loja Parceiro A",
"externalReference": "loja-parceiro-a",
"status": "ACTIVE",
"lockMode": "NONE",
"balance": {
"availablePadrao": 1500,
"pendingPadrao": 0,
"lockedPadrao": 0,
"spendablePadrao": 1500
},
"limits": {
"dailyLimit": null,
"monthlyLimit": null,
"perTransactionLimit": null
},
"createdAt": "2026-06-01T12:00:00.000Z"
},
"requestId": "req_abc123"
}
Gerenciar
Consultar subconta
Retorna subconta por ID interno GoatPay.
GET
/
subaccount
/
get
/
{id}
curl -X GET 'https://api.goatpay.com.br/v1/subaccount/get/clx_subconta' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Subconta",
"data": {
"id": "clx_subconta",
"name": "Loja Parceiro A",
"externalReference": "loja-parceiro-a",
"status": "ACTIVE",
"lockMode": "NONE",
"balance": {
"availablePadrao": 1500,
"pendingPadrao": 0,
"lockedPadrao": 0,
"spendablePadrao": 1500
},
"limits": {
"dailyLimit": null,
"monthlyLimit": null,
"perTransactionLimit": null
},
"createdAt": "2026-06-01T12:00:00.000Z"
},
"requestId": "req_abc123"
}
curl -X GET 'https://api.goatpay.com.br/v1/subaccount/get/clx_subconta' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Subconta",
"data": {
"id": "clx_subconta",
"name": "Loja Parceiro A",
"externalReference": "loja-parceiro-a",
"status": "ACTIVE",
"lockMode": "NONE",
"balance": {
"availablePadrao": 1500,
"pendingPadrao": 0,
"lockedPadrao": 0,
"spendablePadrao": 1500
},
"limits": {
"dailyLimit": null,
"monthlyLimit": null,
"perTransactionLimit": null
},
"createdAt": "2026-06-01T12:00:00.000Z"
},
"requestId": "req_abc123"
}
Parâmetros de rota
string
required
ID da subconta (
clx_...).Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)

