Para criar um pedido com boleto, devemos incluir o objeto boleto dentro do nó payment, assim como a propriedade "payment_method": "boleto". O objeto boleto contém as seguintes propriedades:
| Atributos | Tipo | Descrição |
|---|---|---|
bank | string | Código do banco. 001 (Banco do Brasil); 033 (Santander); 104 (Caixa Econômica Federal); 197 (Banco Stone); 198 (Pagar.me); 237 (Bradesco); 341 (Itau); 376 (JPMorgan); 745 (Citibank) . |
instructions | string | Instruções do boleto. Max: 256 caracteres. |
due_at | datetime | Data de vencimento. (Opcional) |
nosso_numero | string | Número que identifica unicamente um boleto para uma conta. |
type | string | Tipo de espécie do boleto.DM (Duplicata Mercantil) e BDP (Boleto de proposta) |
metadata | object | Objeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento.Saiba mais sobre metadata. |
document_number | string | Identificador do boleto. Max: 16 caracteres. |
statement_descriptor | string | Texto exibido na fatura do boleto. Max: 13 caracteres. (Opcional) |
interest | object | Aplicação do juros após vencimento do boleto. (Opcional) |
interest.days | int | Dias após a expiração do boleto quando o juros deve ser cobrado. (Obrigatório enviar se o objeto interest for enviado) |
interest.type | string | Tipo de divisão. Os valores possíveis são flat ou percentage. (Obrigatório enviar se o objeto interest for enviado) |
interest.amount | int | Valor em porcentagem ou em centavos da taxa de juros que será cobrada ao mês. (Obrigatório enviar se o objeto interest for enviado) |
fine | object | Aplicação de multa após vencimento do boleto. (Opcional) |
fine.days | int | Dias após a expiração do boleto quando a multa deve ser cobrada. (Obrigatório enviar se o objeto fine for enviado) |
fine.type | string | Tipo de divisão. Os valores possíveis são flat ou percentage. (Obrigatório enviar se o objeto fine for enviado) |
fine.amount | int | Valor em porcentagem ou em centavos que será cobrada na multa. (Obrigatório enviar se o objeto fine for enviado) |
CANCELAMENTO DE BOLETO
Para clientes gateway, o cancelamento de uma charge de boleto não gera um estorno financeiro para o cliente final. O cancelamento só modifica o status da charge na API para registro do integrador.
JUROS E MULTA NO BOLETO
Somente clientes com integração do tipo PSP (liquidação via Pagar.me) podem utilizar boletos com Juros e Multa. Cliente com integração Gateway não tem acesso a funcionalidade.
SOBRE OS VALORES (AMOUNT) DE JUROS E MULTA
Os parâmetros
interest.amountefine.amountserão alterados de acordo com ointerest.typeefine.typeutilizados no request:
flat: Representa valores inteiros em centavos, portanto o valor do amount não poderá ser inferior a 1. O amount neste caso será cobrado de forma diária;percentage: Representa valores em porcentagem, portanto o valor do amount neste caso deve ser maior que 0 e menor que 100. Campo aceitará valores parciais com o seguinte formato:"amount": 1.5(Significa Juros/Multa de 1,5% do valor do pedido). O amount neste caso será cobrado de forma mensal;
BOLETOS COM REGISTRO TÊM CAMPOS OBRIGATÓRIOS
Para requisições de cobrança de boletos com registro os campos
name,addressedocumentdo cliente (objetocustomer) devem ser enviados OBRIGATORIAMENTE.
{
"items": [
{
"amount": 2990,
"description": "Chaveiro do Tesseract",
"quantity": 1
}
],
"customer": {
"name": "Tony Stark",
"email": "[email protected]" ,
"document_type": "CPF",
"document": "93095135270",
"type": "Individual",
"address": {
"line_1": "375, Av. General Justo, Centro",
"line_2": "8º andar",
"zip_code": "20021130",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BR"
}
},
"shipping": {
"amount": 100,
"description": "Stark",
"recipient_name": "Tony Stark",
"recipient_phone": "24586787867",
"address": {
"line_1": "10880, Malibu Point, Malibu Central",
"zip_code": "90265",
"city": "Malibu",
"state": "CA",
"country": "US"
}
},
"payments": [
{
"payment_method": "boleto",
"boleto": {
"instructions": "Pagar até o vencimento",
"due_at": "2022-09-20T00:00:00Z",
"document_number": "123",
"type": "DM"
}
}
]
}
{
"id": "or_56GXnk6T0eU88qMm",
"code": "YV3RCRIN24",
"amount": 3090,
"currency": "BRL",
"closed": true,
"items": [
{
"id": "oi_6rXqKEzuZYcRo2zL",
"description": "Chaveiro do Tesseract",
"amount": 2990,
"quantity": 1,
"status": "active",
"created_at": "2019-10-16T17:36:30Z",
"updated_at": "2019-10-16T17:36:30Z"
}
],
"customer": {
"id": "cus_x4nz0P4SbOTA0KBZ",
"name": "Tony Stark",
"email": "[email protected]",
"document": "14582256988",
"type": "individual",
"delinquent": false,
"created_at": "2019-05-02T17:06:01Z",
"updated_at": "2019-06-12T14:50:18Z",
"phones": {}
},
"shipping": {
"amount": 100,
"description": "Stark",
"recipient_name": "Tony Stark",
"recipient_phone": "24586787867",
"address": {
"city": "Malibu",
"state": "CA",
"country": "US",
"zip_code": "90265",
"line_1": "10880, Malibu Point, Malibu Central"
}
},
"status": "pending",
"created_at": "2019-10-16T17:36:30Z",
"updated_at": "2019-10-16T17:36:30Z",
"closed_at": "2019-10-16T17:36:30Z",
"ip": "52.168.67.32",
"session_id": "322b821a",
"device": {
"platform": "ANDROID OS"
},
"location": {
"latitude": "-22.970722",
"longitude": "43.182365"
},
"charges": [
{
"id": "ch_K2rJ5nlHwTE4qRDP",
"code": "YV3RCRIN24",
"gateway_id": "3b4bb2d9-19b3-4638-a974-0bb914fff472",
"amount": 3090,
"status": "pending",
"currency": "BRL",
"payment_method": "boleto",
"created_at": "2019-10-16T17:36:30Z",
"updated_at": "2019-10-16T17:36:31Z",
"customer": {
"id": "cus_x4nz0P4SbOTA0KBZ",
"name": "Tony Stark",
"email": "[email protected]",
"document": "14582256988",
"type": "individual",
"delinquent": false,
"created_at": "2019-05-02T17:06:01Z",
"updated_at": "2019-06-12T14:50:18Z",
"phones": {}
},
"last_transaction": {
"id": "tran_bZ0N3DjjUzTW68eq",
"transaction_type": "boleto",
"gateway_id": "044581ea-67e8-4772-bd56-f10ade5499de",
"amount": 3090,
"status": "generated",
"success": true,
"url": "https://sandbox.pagar.me/Boleto/ViewBoleto.aspx?044581ea-67e8-4772-bd56-f10ade5499de",
"pdf": "https://api.pagar.me/core/v1/transactions/tran_bZ0N3DjjUzTW68eq/pdf",
"line": "34191.75462 24615.781234 41234.510000 3 83840000003090",
"barcode": "https://api.pagar.me/core/v1/transactions/tran_bZ0N3DjjUzTW68eq/barcode",
"qr_code": "https://api.pagar.me/core/v1/transactions/tran_bZ0N3DjjUzTW68eq/qrcode",
"nosso_numero": "46246157",
"type": "DM",
"document_number": "123",
"instructions": "Pagar até o vencimento",
"due_at": "2020-09-20T00:00:00Z",
"created_at": "2019-10-16T17:36:30Z",
"updated_at": "2019-10-16T17:36:30Z",
"gateway_response": {
"code": "201"
},
"antifraud_response": {}
}
}
],
"checkouts": []
}
{
"items": [
{
"amount": 500,
"description": "Chaveiro do Tesseract",
"quantity": 1,
"code": "123"
}
],
"customer": {
"name": "Tony Stark",
"email": "[email protected]",
"document": "21811216137",
"type": "individual",
"address": {
"line_1": "375, Av. General Justo, Centro",
"line_2": "8º andar",
"zip_code": "20021130",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BR"
},
"phones": {
"home_phone": {
"country_code": "55",
"area_code": "21",
"number": "000000000"
},
"mobile_phone": {
"country_code": "55",
"area_code": "21",
"number": "000000000"
}
}
},
"payments": [
{
"payment_method": "boleto",
"boleto": {
"instructions": "Pagar até o vencimento",
"due_at": "2023-07-24T00:00:00Z",
"document_number": "123",
"type": "DM",
"interest": {
"days": "2",
"type": "percentage",
"amount": 20
},
"fine": {
"days": "2",
"type": "flat",
"amount": 10
}
}
}
]
}
{
"id": "or_eKd6Nk7hKyFd2BMl",
"code": "849WF0YCW7",
"amount": 500,
"currency": "BRL",
"closed": true,
"items": [
{
"id": "oi_8pazKKpFnpS9KzE7",
"type": "product",
"description": "Chaveiro do Tesseract",
"amount": 500,
"quantity": 1,
"status": "active",
"created_at": "2022-10-13T20:24:39Z",
"updated_at": "2022-10-13T20:24:39Z",
"code": "123"
}
],
"customer": {
"id": "cus_3LVRrkoUVF8AlrY0",
"name": "Tony Stark",
"email": "[email protected]",
"document": "21811216137",
"document_type": "cpf",
"type": "individual",
"delinquent": false,
"address": {
"id": "addr_KgWJNxBsKsQG7PDj",
"line_1": "375, Av. General Justo, Centro",
"line_2": "8º andar",
"zip_code": "20021130",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BR",
"status": "active",
"created_at": "2021-07-20T14:25:18Z",
"updated_at": "2022-10-13T19:52:19Z"
},
"created_at": "2020-11-23T17:55:51Z",
"updated_at": "2022-10-13T19:52:19Z",
"phones": {
"home_phone": {
"country_code": "55",
"number": "000000000",
"area_code": "21"
},
"mobile_phone": {
"country_code": "55",
"number": "000000000",
"area_code": "21"
}
}
},
"status": "pending",
"created_at": "2022-10-13T20:24:39Z",
"updated_at": "2022-10-13T20:24:39Z",
"closed_at": "2022-10-13T20:24:39Z",
"charges": [
{
"id": "ch_PA50xD0GSaCZxrNB",
"code": "849WF0YCW7",
"gateway_id": "18752786",
"amount": 500,
"status": "pending",
"currency": "BRL",
"payment_method": "boleto",
"created_at": "2022-10-13T20:24:39Z",
"updated_at": "2022-10-13T20:24:39Z",
"customer": {
"id": "cus_3LVRrkoUVF8AlrY0",
"name": "Tony Stark",
"email": "[email protected]",
"document": "21811216137",
"document_type": "cpf",
"type": "individual",
"delinquent": false,
"address": {
"id": "addr_KgWJNxBsKsQG7PDj",
"line_1": "375, Av. General Justo, Centro",
"line_2": "8º andar",
"zip_code": "20021130",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BR",
"status": "active",
"created_at": "2021-07-20T14:25:18Z",
"updated_at": "2022-10-13T19:52:19Z"
},
"created_at": "2020-11-23T17:55:51Z",
"updated_at": "2022-10-13T19:52:19Z",
"phones": {
"home_phone": {
"country_code": "55",
"number": "000000000",
"area_code": "21"
},
"mobile_phone": {
"country_code": "55",
"number": "000000000",
"area_code": "21"
}
}
},
"last_transaction": {
"id": "tran_naLPrX2COIlEAol9",
"transaction_type": "boleto",
"gateway_id": "18752786",
"amount": 500,
"status": "generated",
"success": true,
"url": "https://pagar.me",
"pdf": "https://pagar.me?format=pdf",
"line": "1234 5678",
"barcode": "https://api.pagar.me/core/v5/transactions/tran_naLPrX2COIlEAol9/barcode",
"qr_code": "https://api.pagar.me/core/v5/transactions/tran_naLPrX2COIlEAol9/qrcode",
"nosso_numero": "18752786",
"type": "DM",
"bank": "198",
"document_number": "18752786",
"instructions": "Pagar até o vencimento",
"due_at": "2023-07-24T23:59:59Z",
"interest": {
"days": 2,
"type": "percentage",
"amount": 20.0
},
"fine": {
"days": 2,
"type": "flat",
"amount": 10.0
},
"created_at": "2022-10-13T20:24:39Z",
"updated_at": "2022-10-13T20:24:39Z",
"gateway_response": {
"code": "200"
},
"antifraud_response": {}
}
}
],
"checkouts": []
}
Status das transações de boleto (Transaction)
As transações de boleto podem possuir os seguintes status:
| Status | Descrição |
|---|---|
generated | Gerado |
viewed | Visualizado |
underpaid | Pago a menor |
overpaid | Pago a maior |
paid | Pago |
voided | Cancelado |
with_error | Com erro |
failed | Falha |
processing | Boleto ainda está em etapa de criação |