Pagamento de títulos e convênios

Registrar boleto para pagamento

O pagamento de um título, boleto ou convênio na plataforma é dividida em duas etapas principais: registrar o título ou convênio e posteriormente efetivar ou agendar o pagamento.

Para a etapa de registro de pagamento basta informar o código de barras ou a linha digitável. Assim que o cadastro do título para pagamento for efetivado, é necessário que o pagamento seja confirmado ou agendado para uma data futura. Mais detalhes podem ser encontrados no endpoint de registro de título ou convênio para pagamento (Cadastrar título ou convênio para pagamento).

Pagamento

Confirmar pagamento

Quando confirmado, o pagamento entrará para a fila de processamento, e será marcado com o status WAITING. A efetivação do pagamento acontecerá até o final da janela de processamento do dia.

A janela de processamento encontra-se no período de 09:00 às 20:00!

Agendar pagamento

Também é possível que um pagamento seja agendado para uma data futura. Neste caso ele possuirá o status SCHEDULED até a data do pagamento, após isso será processado normalmente.

Ambas opções, confirmação do pagamento e agendamento do pagamento devem ser realizadas atráves do endpoint Confirmar ou agendar pagamento de título.

Saldo insuficiente

Caso o usuário não possua saldo suficiente em conta no momento da confirmação do pagamento, este processo não poderá ser realizado.

Nos casos onde há o agendamento do pagamento do título, o atributo maxRetriesOnError pode ser usado para indicar o número de vezes que o título pode entrar na fila de processamento durante o dia do agendamento, caso o usuário não possua saldo na conta no momento do processamento do pagamento.

Nestes casos o pagamento tentará ser processado o número de vezes estipulado no atributo maxRetriesOnError, com intervalos de tempo de uma hora, possibilitando assim que o usuário possa inserir saldo na conta para compensação do pagamento.

Cancelamento do pagamento

Quando agendado, um pagamento de título ou convênio pode ser cancelado a qualquer momento. Pagamentos já processados não são passíveis de cancelamento.

Tipos de boletos

Observação: Quando o boleto for do tipo DEALERSHIP o beneficiário será o cedente que corresponde ao campo assignor

Códigos de status

Durante o fluxo de processamento, um pagamento poderá possuir diferentes status, que indicam em qual fase do processo ele está.

Aplicação de taxas

Taxas podem ser aplicadas a pagamentos de títulos quando assim for definido pelo cliente. As taxas recolhidas são contabilizadas na conta principal do cliente.

A aplicação de taxas podem ser definidas através da configuração de intervalos de valores. Podendo-se aplicar uma taxa diferente, dependendo do valor da operação, na forma de valor absoluto ou percentual.

Referência