Skip to main content
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": {
      "spendableWhite": 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": {
      "spendableWhite": 1500
    }
  },
  "requestId": "req_abc123"
}

​
Parâmetros de rota

​
externalReference
string
required
Valor enviado em POST /subaccount/create.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
externalReference
string
required

Response

Operação concluída.

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Pagamento PIX criado com sucesso"

​
data
object
required
​
requestId
string