Documentação APIs

Lista de Contas de Clientes

Esta API retorna a lista de contas dos clientes que um determinado assessor tem acesso.

🚧

Requisição Paginada

Em casos de parceiros com uma lista de clientes extensa, recomendamos o uso de paginação para buscar a lista por partes.

Para isso, basta preencher os parâmetros de busca offset e limit, onde offset determina o índice inicial da busca e o limit o número de registros a partir do índice determinado.

Para saber o número total de clientes, basta verificar o header X-Total-Records-Count na resposta da API.


Serializador

Os serializadores são responsáveis por alterar o comportamento dos resultados retornados pela API.

Serializadores disponíveis:

Serializer NameDetalheCode
PadrãoSerializer padrão do endpoint
SimplesInforma menos detalhes do perfil do clientesimple
Com SaldoInforma saldo da conta corrente do clientewith_balance
Language
Click Try It! to start a request and see the response here!