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 |
---|---|---|
| string | Código do banco. |
| string | Instruções do boleto. Max: 256 caracteres. |
| datetime | Data de vencimento. (Opcional) |
| string | Número que identifica unicamente um boleto para uma conta. |
| string | Tipo de espécie do boleto. |
| object | Objeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento.Saiba mais sobre metadata. |
| string | Identificador do boleto. Max: 16 caracteres. |
| string | Texto exibido na fatura do boleto. Max: 13 caracteres. (opcional) |
CANCELAMENTO DE BOLETO
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.
BOLETOS COM REGISTRO TÊM CAMPOS OBRIGATÓRIOS
Para requisições de cobrança de boletos com registro os campos
name
,address
edocument
do 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": []
}
Status das transações de boleto (Transaction)
As transações de boleto podem possuir os seguintes status:
Status | Descrição |
---|---|
| Gerado |
| Visualizado |
| Pago a menor |
| Pago a maior |
| Pago |
| Cancelado |
| Com erro |
| Falha |
| Boleto ainda está em etapa de criação |