Uma transação com boleto bancário é a forma mais simples de emitir uma cobrança para o seu cliente usando o Pagar.me. Veja o exemplo:
Não se esqueça de incluir a sua [chave de API](🔗), que está disponível em sua [Dashboard](🔗).
## Status da transação
A transação tem status `waiting_payment` até o pagamento do boleto bancário. A URL do boleto bancário para pagamento está disponível na variável `boleto_url`. Quando o boleto bancário for detectado como pago, a transação passa a ter o status `paid`. Lembrando que o boleto_url não é retornado no ambiente de testes, sendo que o parâmetro "boleto_url" é preenchido com o seguinte link "https://pagar.me".
## Mais parâmetros
Além dos parâmetros passados no exemplo, você ainda pode usar:
| Parâmetro | Padrão | Descrição |
| amount | --- | Valor total a ser cobrado (em centavos). Ex: R$14,99 = `1499`
Tipo: `integer` |
| payment_method | credit_card | Meio de pagamento a ser utilizado |
| boleto_instructions | [Instruções da dashboard](🔗) | Campo instruções do boleto. Máximo de 255 caracteres. Obs. Utilizar \n para quebra de linha |
| boleto_expiration_date | data atual + 7 dias | Data de vencimento do boleto bancário em ISODate. Exemplo: 2017-12-31T23:59:59.000Z |
| postback_url | --- | URL para receber notificações sobre alterações da transação |
| boleto_fine.days | --- | Dias após a expiração do boleto quando a multa deve ser cobrada.
Tipo: `integer` |
| boleto_fine.amount | --- | Valor em centavos da multa.
Tipo: `integer` |
| boleto_fine.percentage | --- | Valor em porcentagem da multa.
Tipo: `number` |
| boleto_interest.days | --- | Dias após a expiração do boleto quando o juros deve ser cobrado.
Tipo: `integer` |
| boleto_interest.amount | --- | Valor em centavos da taxa de juros que será cobrado ao dia.
Tipo: `integer` |
| boleto_interest.percentage | --- | Valor em porcentagem da taxa de juros que será cobrado ao mês.
Tipo: `number` |
| boleto_rules | --- | Permite aplicar regras ao boleto emitido. Valores possíveis: 'strict_expiration_date' (restringe o pagamento para até a data de vencimento e apenas o valor exato do documento), 'no_strict' (permite pagamento após o vencimento e valores diferentes do impresso)
Tipo: `array` |
Limites para juros e multas
Não recomendamos o uso de taxas de juros superiores a 1% a.m e valores de multa superiores a 2% a.m devido as regulações determinadas pelos artigos 52, parágrafo primeiro do código de defesa do consumidor e art. 406, do Código Civil e 161 parágrafo primeiro do Código Tributário Nacional.
Boleto em PDF
Além da versão HTML dos boletos retornada pela API, é possível gerar uma versão em PDF. Para tal basta adicionar o sufixo ?format=pdf na url retornada. Segue um exemplo: URL ORIGINAL: https://api.pagar.me/1/boletos/test_ckj9yiyvy1obb0gm5g9yfpgbw URL PDF: https://api.pagar.me/1/boletos/test_ckj9yiyvy1obb0gm5g9yfpgbw?format=pdf
Captura de transação no Boleto Bancário
Para transações realizadas com `
encryption_key` o valor padrão do `capture` é `false`, porém você pode realizar a captura alterando o valor para `true`. **Somente para Boleto Bancário**.
Código de Barras e Link para Download do Boleto Bancário
Para obter o Código de Barras e o Link para Download do Boleto você deve passar o parâmetro `
capture` como `true`. Ou você pode realizar a captura posteriormente através da rota `/capture`, para mais informações [clique aqui](🔗).
Aprenda mais sobre a lista completa de parâmetros em: [Criar transação](🔗)
O Boleto bancário resultante tem os parâmetros mostrados como este:
Boleto resultante
## Dados do cliente no boleto
Sempre que possível, passe mais informações do seu cliente no momento da criação da transação de Boleto bancário. Faça isso para facilitar a identificação da transação tanto na sua Dashboard quanto no seu próprio sistema.
Dados do cliente
Além do valor a ser pago (`
amount`) e do método de pagamento (`payment_method`), para a criação de transações de boleto é necessário informar também os parâmetros `customer.name` e `customer.document_number`.Esses parâmetros não são obrigatórios nesta versão da API, porém são exigidos pela FEBRABAN para a criação de boletos registrados.
Pagando um boleto em teste
Você pode simular o pagamento do boleto usando a seguinte chamada: