Referência da API/Subcontas
GET

Consulta uma subconta da empresa dona da chave de API

Consulta uma subconta da empresa dona da chave de API

GET/v1/subaccounts/{subaccountId}
https://integrate.api.kyvopay.com.br
cURL
curl -X GET https://integrate.api.kyvopay.com.br/v1/subaccounts/{subaccountId} \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX"
Resposta200 OK
{
  "data": {
    "daily_limit_centavos": "4990",
    "document": "12345678909",
    "email": "cliente@example.com",
    "external_reference": "pedido-12345",
    "id": "01HZ8K3M5N",
    "is_blocked": false,
    "monthly_limit_centavos": "4990",
    "name": "Cliente Exemplo",
    "public_id": "01HZ8K3M5N"
  },
  "error": {
    "code": "string",
    "details": {},
    "message": "string"
  },
  "request_id": "req_01HZ8K3M5N"
}

Autenticação

X-API-Keystring · headerobrigatório

Use a chave ky_... criada em Integrações → Chaves de API no painel KyvoPay.

Requisição

Parâmetros

subaccountIdstringobrigatório

Identificador da subconta.

Precisa de ajuda? Fale com o suporte
© 2026 KyvoPay