Skip to main content
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": {
      "availableWhite": 1500,
      "pendingWhite": 0,
      "lockedWhite": 0,
      "spendableWhite": 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": {
      "availableWhite": 1500,
      "pendingWhite": 0,
      "lockedWhite": 0,
      "spendableWhite": 1500
    },
    "limits": {
      "dailyLimit": null,
      "monthlyLimit": null,
      "perTransactionLimit": null
    },
    "createdAt": "2026-06-01T12:00:00.000Z"
  },
  "requestId": "req_abc123"
}

​
Parâmetros de rota

​
id
string
required
ID da subconta (clx_...).

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

Response

Operação concluída.

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Pagamento PIX criado com sucesso"

​
data
object
required
​
requestId
string