⌘K

Boleto — Pagamento de Boletos

O módulo Boleto permite consultar e pagar boletos de terceiros a partir da sua conta, acompanhar o status de cada pagamento e baixar o comprovante em PDF.

Base URL para todos os endpoints de Boleto: https://pagamentos.basspago.com.br/api/v2 — mesma Accounts API do Cash Out. A autenticação usa o mesmo token OAuth2 do Cash Out (POST /api/v2/oauth/token, body JSON em camelCase, expiração de 3600s). Escopos: billets.read (consultas) e billets.write (pagamentos).

Este módulo é exclusivamente para pagamento de boletos de terceiros (cash out). A emissão de boletos não está disponível — não existem endpoints de emissão, boleto híbrido (bolepix) nem webhook dedicado de boleto.

Fluxo de Integração

1Obter Token de autenticação OAuth2 (mesmo do Cash Out)

2Consultar o boleto (POST /billets/info)

3Iniciar o pagamento (POST /billets/pay ou POST /billets/payments)

4Acompanhar o status (GET /billets/{id})

5Baixar o comprovante em PDF (opcional)

O pagamento sempre considera o valor atualizado do boleto, incluindo juros e multas calculados na data de liquidação. Boletos cujo valor pode ser alterado livremente pelo pagador devem ser pagos por canal administrativo autorizado.

Status do Pagamento

Status	Descrição
`ON_QUEUE`	Pagamento aceito e aguardando processamento na fila.
`WAITING_APPROVAL`	Pagamento retido aguardando aprovação manual no painel (paymentFlow APPROVAL_REQUIRED).
`WAITING_CONFIRMATION`	Pagamento enviado e aguardando confirmação de liquidação.
`PROCESSING`	Pagamento em processamento.
`LIQUIDATED`	Pagamento liquidado com sucesso.
`CANCELED`	Pagamento cancelado (rejeitado, expirado ou reprovado).
`REFUNDED`	Pagamento devolvido integralmente.
`PARTIALLY_REFUNDED`	Pagamento devolvido parcialmente.

Endpoints Disponíveis

POST/billets/info

Consulta os dados de um boleto pela linha digitável ou código de barras, incluindo o valor atualizado.

POST/billets/payments

Inicia o pagamento de um boleto informando a linha digitável.

POST/billets/pay

Inicia o pagamento de um boleto previamente consultado, informando o código do boleto.

GET/billets

Lista os pagamentos de boleto realizados, com paginação.

GET/billets/{id}

Consulta o status e os detalhes completos de um pagamento de boleto.

GET/billets/payments/receipt/{id}

Baixa o comprovante do pagamento em PDF (base64).