curl -X GET 'https://api.goatpay.com.br/v1/subaccount/list?page=1&limit=20&status=ACTIVE' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Subcontas",
"data": {
"items": [
{
"id": "clx_subconta",
"name": "Loja Parceiro A",
"externalReference": "loja-parceiro-a",
"status": "ACTIVE",
"lockMode": "NONE",
"balance": {
"availablePadrao": 1500,
"pendingPadrao": 0,
"lockedPadrao": 0,
"spendablePadrao": 1500
}
}
],
"page": 1,
"limit": 20,
"total": 1,
"pages": 1
},
"requestId": "req_abc123"
}
Gerenciar
Listar subcontas
Lista subcontas da conta com paginação.
GET
/
subaccount
/
list
curl -X GET 'https://api.goatpay.com.br/v1/subaccount/list?page=1&limit=20&status=ACTIVE' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Subcontas",
"data": {
"items": [
{
"id": "clx_subconta",
"name": "Loja Parceiro A",
"externalReference": "loja-parceiro-a",
"status": "ACTIVE",
"lockMode": "NONE",
"balance": {
"availablePadrao": 1500,
"pendingPadrao": 0,
"lockedPadrao": 0,
"spendablePadrao": 1500
}
}
],
"page": 1,
"limit": 20,
"total": 1,
"pages": 1
},
"requestId": "req_abc123"
}
curl -X GET 'https://api.goatpay.com.br/v1/subaccount/list?page=1&limit=20&status=ACTIVE' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Subcontas",
"data": {
"items": [
{
"id": "clx_subconta",
"name": "Loja Parceiro A",
"externalReference": "loja-parceiro-a",
"status": "ACTIVE",
"lockMode": "NONE",
"balance": {
"availablePadrao": 1500,
"pendingPadrao": 0,
"lockedPadrao": 0,
"spendablePadrao": 1500
}
}
],
"page": 1,
"limit": 20,
"total": 1,
"pages": 1
},
"requestId": "req_abc123"
}
Query
integer
Página (padrão 1).
integer
Itens por página (máx. 100, padrão 20).
string
ACTIVE ou DISABLED. Subcontas excluídas não aparecem na listagem.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Available options:
ACTIVE, DISABLED 
