Consultar subconta
GET
https://{apiUrl}/subaccount/{id}Atualizado em · 1 min de leitura
Consulta dados da subconta
Endpoint: GET https://{apiUrl}/subaccount/{id}
Recupera as informações de uma subconta específica.
Parâmetros
GET
https://{apiUrl}/subaccount/{id}URL base da API
Token de autenticação
Path Params
idstringrequired
Identificador único da subconta (UUID)
curl --request GET \
--url "https://{apiUrl}/subaccount/{id}"Response
Choose an example:
application/json
O token gerado no momento de criar a subconta não será retornado nas consultas. Caso necessário, gere um novo token pelo endpoint Credenciais da subconta.
Exemplo de resposta
json
{
"id": "subconta-uuid-aqui",
"status": "approved",
"name": "Empresa XYZ",
"document": "12345678000190",
"document_type": "CNPJ",
"created_at": "2024-10-01T15:36:00Z"
}Campos da resposta
idstring
UUID único da subconta
statusstring
Estado: approved, pending, rejected, blocked ou cancelled
namestring
Razão social ou nome da subconta
documentstring
CPF ou CNPJ da subconta
document_typestring
Tipo: CPF ou CNPJ
created_atstring
Data de criação no formato ISO 8601
Esta página foi útil?