Confira a seguir as orientações para as dúvidas mais comuns referentes às nossas APIs.
Como realizo o cancelamento de um cartão?
Os cartões devem ser cancelados pelo parceiro por meio de requisição no endpoint de alteração do status do cartão.
No campo status, informe um dos seguintes valores:
| Status | Tipo | Descrição |
|---|---|---|
| UseFraudCanceled | Irreversível | Cancelado por uso em transações com fraude. |
| UpdateRegisterCanceled | Irreversível | Cancelado por pendência de atualização cadastral. |
| RegisterFraudCanceled | Irreversível | Cancelado por suspeita de fraude no cadastro. |
| CanceledByCustomer | Irreversível | Cancelado pelo cliente. |
| CanceledByEmitter | Irreversível | Cancelado pelo emissor/parceiro. |
| ExpiredCanceled | Irreversível | Cancelado por expiração. |
| StrayedCanceled | Irreversível | Cancelado por extravio. |
| DeathCanceled | Irreversível | Cancelado por morte. |
| LostOrTheftCanceled | Irreversível | Cancelado por perda ou roubo. |
| CardCanceledByAccount | Irreversível | Cancelado após conta cancelada. |
Nota
Para conhecer todos os status, acesse a documentação Possíveis do status do cartão.
Como realizo o cancelamento de uma conta?
As contas podem ser canceladas pelo parceiro por meio do endpoint de encerramento de conta.
Importante
Caso deseje encerrar o vínculo comercial com o cliente, ou seja, cancelar todas as contas de um documento, considere utilizar a API de Offboarding.
O que devo fazer para aumentar o limite de uma operação?
Para alterar o limite de uma operação, o parceiro deve abrir um chamado via Service Desk e informar os seguintes dados:
- Número do documento (CPF/CNPJ);
- Nome da Company Key;
- Limite a ser alterado: global ou personalizado por produto (por documento/Company Key). Caso se trate do limite da produto, também é preciso informar o limite transacional, diário e mensal;
- Motivo da alteração do limite.
Nota
Antes de abrir o chamado, verifique se o seu cliente realmente atingiu seu limite operacional e se ele possui movimentações suficientes que justifiquem o aumento de limite.
Importante
Documentos com restrições internas no Bankly ou na Receita Federal terão aumento de limite negado automaticamente.
Qual é o procedimento para a devolução de saldo dos meus clientes?
Se o cliente possui uma conta ativa, o próprio parceiro pode realizar a devolução do saldo, por meio de uma de nossas APIs de transferência:
Importante
Caso o cliente não possua uma conta ativa, abra um chamado via Service Desk e informe os dados bancários para a devolução do saldo.
Que informações devo enviar ao abrir um chamado relacionado a transações (TED, boleto ou Pix)?
Sempre que houver a necessidade de abrir um chamado relacionado a transações via TED, boleto ou Pix, é preciso enviar, no mínimo:
- O
authenticationCode(código de autenticação da transação); - A data em que a transação ocorreu;
- O valor da transação.
Como consigo os dados necessários para gerar os comprovantes de transações (boleto, cartão, faturas, Pix e TED)?
Todas as informações necessárias para gerar comprovantes de transações chegam ao parceiro por webhooks, que disparam mensagens automáticas assim que os eventos ocorrem:
Importante
Para garantir o recebimento desses eventos, é preciso que o parceiro tenha realizado a configuração dos webhooks.
O parceiro também poderá utilizar os endpoints de consulta de cada produto:
Onde obtenho as informações para gerar extratos para meus clientes?
É possível obter todas as informações para a geração de extratos por meio dos webhooks, que disparam mensagens automáticas assim que os eventos ocorrem.
Importante
Reforçamos que, para receber esses eventos, é preciso que o parceiro tenha realizado a configuração dos webhooks.
O parceiro também pode utilizar o endpoint de feed de eventos para obter essas informações.
Importante
A consulta de eventos retorna no máximo 10.000 eventos por vez. Quando é gerado um novo evento, para que este seja retornado na consulta, o mais antigo é excluído. Portanto, recomendamos salvar o retorno da última consulta realizada no fim do dia em uma base de dados própria, para que o conteúdo não se perca com a atualização dos eventos.
Não consegui realizar uma TED. O que pode ter ocorrido?
Ao realizar a consulta do status de uma TED, é possível que o campo status indique que a transação não pôde ocorrer. Para além dos motivos listados na tabela Possíveis status da transação, recomendamos verificar a agência e a conta informadas na requisição, bem como assegurar-se de que todos os campos obrigatórios citados na documentação Transferência via TED foram enviados corretamente.
Onde obtenho informações sobre o status do registro do meu cliente?
Cada vez que o status de registro de um cliente é atualizado, o parceiro é notificado por mensagem via webhook (desde que o webhook tenha sido configurado).
Dica
Consulte a documentação de eventos de pessoa física para conhecer todos os eventos enviados.
Também é possível utilizar o endpoint de consulta do registro do cliente para obter informações sobre seu status.
Como funciona a política de rate limiting do Bankly?
A política de rate limiting estabelece o número máximo de requisições que podem ser realizadas em nossa plataforma em um determinado intervalo de tempo.
Dica
Para conhecer os tipos de rate limiting e o número máximo de requisições por contexto, recomendamos a leitura da documentação Rate limiting.
Updated 5 months ago