curl -X POST 'https://api.goatpay.com.br/v1/subaccount/delete' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "id": "clx_subconta" }'
{
"success": true,
"message": "Subconta excluída",
"data": {
"id": "clx_subconta"
},
"requestId": "req_abc123"
}
{
"success": false,
"message": "Subconta possui saldo. Remova o saldo antes de excluir.",
"requestId": "req_abc123"
}
Gerenciar
Excluir subconta
Remove a subconta da sua conta quando o saldo estiver zerado.
POST
/
subaccount
/
delete
curl -X POST 'https://api.goatpay.com.br/v1/subaccount/delete' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "id": "clx_subconta" }'
{
"success": true,
"message": "Subconta excluída",
"data": {
"id": "clx_subconta"
},
"requestId": "req_abc123"
}
{
"success": false,
"message": "Subconta possui saldo. Remova o saldo antes de excluir.",
"requestId": "req_abc123"
}
curl -X POST 'https://api.goatpay.com.br/v1/subaccount/delete' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "id": "clx_subconta" }'
{
"success": true,
"message": "Subconta excluída",
"data": {
"id": "clx_subconta"
},
"requestId": "req_abc123"
}
{
"success": false,
"message": "Subconta possui saldo. Remova o saldo antes de excluir.",
"requestId": "req_abc123"
}
string
required
ID da subconta. Todos os saldos (
availablePadrao, pendingPadrao, lockedPadrao) devem estar zerados.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Body
application/json