Sobre o pagamento de contas
Essa funcionalidade permite realizar pagamentos das mais diversas modalidades, incluindo contas de água, luz, gás, telefone, internet, multas, tributos e boletos.
Nesse artigo você irá aprender como:
- Consultar informações da conta
- Realizar o pagamento da conta
- Consultar a situação da ordem de pagamento
Tipos de Contas
Boleto bancários (BilletPayment): São boletos bancários, seus dígitos iniciam sempre com o código do banco.
Concessionárias (PartnerPayment): São contas de consumo, ou de órgãos governamentais, seu dígito sempre começa com o número 8 e para os órgãos governamentais iniciam geralmente com os dígitos 85 e 81.
Diagrama de Sequência - Pagamento de Contas
Consultar os dados de uma conta
Para realizar a consulta das informações do pagamento é preciso estar autenticado ver Ver Realize sua primeira consulta
Para realizar a consulta de um pagamento, o usuário deverá informar a linha digitável da conta na URL da requisição.
O retorno conterá as informações da conta:
- Valor do documento;
- Valor total;
- Informações do beneficiário;
- Informações de juros e acréscimos;
- Informações de descontos;
- Data de vencimento.
Pagar a conta
Para realizar o pagamento da conta será necessário informar os dados listados na "tabela. dados do pagamento". Os pagamentos enviados com a data corrente serão enviados no mesmo dia para o liquidante. Pagamentos com datas futuras, serão agendadas para processamento na data informada.
Situação do pagamento
Todo pagamento válido, inicia com a situação de pending indicando que o pagamento está pendente de processamento.
- Waiting - Esta situação, indica que o pagamento foi agendado para processamento futuro e está "esperando" o dia de seu processamento informado no campo date.
- Scheduled - Esta situação, indica que o pagamento foi acolhido para processamento indicando que todos dados do pagamento e do saldo da conta estam válidos para envio ao liquidante.
- Ticketed - Esta situação, indica que o pagamento foi enviado e acolhido pelo liquidante.
- Done - Esta situação, indica que o pagamento foi confirmado pelo liquidante.
- Late - Esta situação, indica que o pagamento não foi aceito pelo liquidante.
- Canceled - Esta situação, indica que o pagamento foi cancelado pelo operador de Backoffice.
- Reversed - Esta situação, indica que o pagamento foi estornado ou pelo liquidante.
Tabela dados do pagamento
| Campo | Tipo | Descrição |
|---|---|---|
| date | Data (YYYY-MM-DD) | Data que o pagamento deverá ser processado. |
| value | Decimal | Valor nominal do título |
| total | Decimal | Valor atualizado a ser pago do título |
| rebate | Decimal | Valor total de abatimentos |
| interest | Decimal | Valor total de multas |
| discount | Decimal | Valor total de descontos |
| document_number | String | Linha digitável |
| account | String | Número da conta* |
*Obrigatório somente para pagamentos na camada de banking.
Consultar situação do pagamento
Existem duas formas de se obter a situação do pagamento, realizando uma consulta na API de Consulta de pagamento ou cadastrando um webhook para receber as notificações de pagamentos:
Requisição na API de consulta:
Para realizar a consulta da situação do pagamento deve ser informado o ID da ordem de pagamento retornado na requisição de pagamento de boleto bancário ou obtido na API de pagamento de conta de concessionária.
O retorno da requisição possuí o campo status para identificar a situação do pagamento.
Webhook de pagamentos:
➡️ Entre em contato com o atendimento do suporte por email ou pelo chat
Updated 8 months ago