curl -X GET 'https://api.goatpay.com.br/v1/subaccount/get-by-ref/loja-parceiro-a' \
-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": {
"spendablePadrao": 1500
}
},
"requestId": "req_abc123"
}
Gerenciar
Consultar subconta por referência
Retorna subconta pelo externalReference informado na criação.
GET
/
subaccount
/
get-by-ref
/
{externalReference}
curl -X GET 'https://api.goatpay.com.br/v1/subaccount/get-by-ref/loja-parceiro-a' \
-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": {
"spendablePadrao": 1500
}
},
"requestId": "req_abc123"
}
curl -X GET 'https://api.goatpay.com.br/v1/subaccount/get-by-ref/loja-parceiro-a' \
-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": {
"spendablePadrao": 1500
}
},
"requestId": "req_abc123"
}
Parâmetros de rota
string
required
Valor enviado em
POST /subaccount/create.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.