Objetivo
Facilitar operações de pagamentos das mais diversas modalidades, incluindo contas de água, luz, gás, telefone, internet, multas, tributos e boletos, de forma escalável e auto-gerenciável sem a necessidade de intervenções manuais.
Demanda
A demanda consiste em realizar consultas e pagamentos de contas a partir de uma integração sistêmica. O cliente deve utilizar a funcionalidade via uma interface WEB, ou via integração por API.
Procedimento Existente
O gerenciamento de pagamento de contas fica a cargo do cliente que está integrando, onde ele executa cada operação individualmente.
Requisitos
Como requisito será necessário criar:
-
Possuir uma chave de autenticação.
-
Ter familiaridade com o padrão REST usando o protocolo OAuth 2.0.
-
Ter o produto/solução contratado.
Instruções
O pagamento de contas é uma operação de processamento síncrono, onde os resultados são retornados no momento de sua execução
Nota:
O pagamento de contas é realizado em dias úteis das 08:00 às 20:00, com exceções de algumas concessionárias que podem se estender até às 22:00. Fora destas grades, o mesmo é agendado para o próximo dia útil.
Glossário:
Ficha de compensação: São boletos bancários, seus dígitos iniciam sempre com o código do banco, por exemplo, no caso do Bradesco o começo da linha digitável será preenchido com o número 237.
Concessionárias: São contas de consumo, ou de órgãos governamentais, alguns exemplos de consumo, água, luz, telefone, internet, seu dígito sempre começa com o número 8 e para os órgãos governamentais como tributos, um exemplo seria o IPVA, iniciam geralmente com os dígitos 85 e 81.
1.Consulta
1.1 Consultar detalhes de uma conta:
Essa consulta serve para verificar os detalhes do conta, segue exemplo de resultado sem erros:
Endpoint
- POST /cashout/boleto/details/{number}
Exemplo cURL:
curl --location --request GET 'https://{URI}/cashout/boleto/details/0339189250000050874937445070000293833818***' \
--header 'Atar-ApiKey: 00be0083-8c8d-4d09-9f8f-***********' \ # Api key de acesso
--header 'Authorization: Bearer eyJhbGciOiJIUzI1**********' \ # token
--header 'Content-Type: application/json' \
--data-raw ''
Exemplo de resposta:
{
"assignor": "string",
"settledate": "string",
"discount": 0,
"maxValue": 0,
"minValue": 0,
"beneficiary": "string",
"canChangeAmount": true,
"amount": 0,
"interest": 0,
"originalAmount": 0,
"typefulLine": "string",
"beneficiaryDocument": "string",
"dueDate": "string"
}
2. Execução
2.1 Confirmar o pagamento de uma conta:
Para iniciar o pagamento do boleto é necessário o envio do código de barras e o valor a ser pago, segue detalhamento do passo a passo do processo.
- POST /cashout/boleto
Campos de entrada:
{
"amount": 0, #valor a ser pago
"code": "string" #código de barras ou linha digitável
}
Exemplo de cURL:
curl --location -g --request POST 'https://{URI}/cashout/boleto' \
--header 'Atar-ApiKey: 00be0083-8c8d-4d09-9f8f-***********' \ # Api key de acesso
--header 'Authorization: Bearer eyJhbGciOiJIUzI1**********' \ # token
--header 'Content-Type: application/json' \
--data-raw '{
"code": "0339189250000050874937445070000293833818***1",
"amount": "***"
}'
Exemplo de resposta:
{
"status": "paid",
"settleDate": "string",
"timestamp": "string",
"amountPaid": 0,
"dueDate": "string",
"assignor": "string",
"payer": "string",
"payerDocument": "string",
"beneficiary": "string",
"amount": 0,
"details": {
"BlocoCompleto": "string",
"convenant": "string"
},
"typefulLine": "string",
"transactionId": "string",
"beneficiaryDocument": "string"
}
3. Devolução ou cancelamento de um pagamento
3.1 Devolução de um pagamento:
Ao realizar o pagamento de uma conta, o beneficiário, entidade final que está recebendo o crédito, pode rejeitar um ou alguns pagamentos. Nesses casos, a Atar ao identificar essa situação devolve o saldo na conta correspondente. Por regra da Febraban, o prazo para recebimento da rejeição do cedente é de até 5 dias úteis.
| Erro | Descrição |
|---|---|
| 12 - Data Validade/Vencimento Expirada. Pagamento/Agendamento Não Permitido. Data de Pagamento Após Vencimento | Data de vencimento expirada |
| 10 - Pagamento não autorizado - Valor divergente ao informado pelo beneficiário, o pagador deve verificar | Divergência de valor com a CIP |
| 23 - O boleto não poder ser recebido, pois encontra-se liquidado | Boleto já pago |
| 23 - O boleto não poder ser recebido, pois encontra-se baixado | Título já baixado |
| Ocorrência: AJ - Tipo de Movimento Inválido | Erro genérico para recusas. Favor entrar em contato com nosso suporte |
| Repasse em duplicidade pela IF Recebedora de boletos | Boleto já pago |
| Boleto de pagamento recebido com desconto ou abatimento não previsto no boleto de pagamento | Divergência de valor com a CIP |
| Pagamento de Boleto divergente da base centralizada | Divergência de informação com a CIP |
| Código de barras em desacordo com as especificações | Divergência de informação com a CIP |
| Boleto inexistente na Base Centralizada de Boletos de Pagamentos | Boleto não localizado |
| 14 - Boleto bloqueado para pagamento, o pagador deve verificar com seu beneficiário | Título já baixado |
| 276 - Boleto já recebido nesta data | Boleto recebido dentro do mesmo dia |
| NC - Valor registrado diferente na CIP ou valor não atualizado para pagamento | Divergência de valor com a CIP |
| H6 - Outros Motivos de Glosa | Erro genérico para recusas. Favor entrar em contato com nosso suporte |
| Código de Barras Inválido | Divergência de informação com a CIP |
| Devolução de Pagamento Fraudado – documentos com código de barras | Pagamento identificado como fraude |
| Boleto em cartório ou protestado – Documentos com código de barras. | Boleto protestado |
| 13 - Data limite para pagamento excedida, o pagador deve verificar com o Beneficiário | Data limite de pagamento excedida |
| Já Pago | Boleto já pago |
| Boleto divergente na Base Centralizada de Boletos de Pagamentos | Boleto divergente da CIP |
| 2 - Operação Falhou | Erro genérico para recusas. Favor entrar em contato com nosso suporte |
Cadastre um serviço Webhook para receber todas as notificações de eventos das transações, de forma prática e eficaz.
4. Fluxograma
Fluxograma das principais caracteristicas do pagamento de contas.
5. Suporte
Central de ajuda Atar: Servide desk
Email: [email protected]