Passo-a-passo - Cobrando com Boleto
1. Primeiro passo: Criar uma Cobrança
Você deve integrar seu sistema com a Charge API usando o recurso /charges informando a forma de pagamento BOLETO no parâmetro payment_method.type além do objeto boleto contendo as informações necessárias para emissão do Boleto que também será registrado junto a CIP e banco emissor, veja a seguir exemplo de dados requeridos:
- Nome do pagador;
- Identidade (CPF/CNPJ);
- Email;
- Endereço completo de cobrança;
Veja abaixo um exemplo básico de uso:
{
"reference_id": "ex-00001",
"description": "Motivo da cobrança",
"amount": {
"value": 1000,
"currency": "BRL"
},
"payment_method": {
"type": "BOLETO",
"boleto": {
"due_date": "2019-05-08",
"instruction_lines": {
"line_1": "Pagamento processado para DESC Fatura",
"line_2": "Via PagSeguro"
},
"holder": {
"name": "Jose da Silva",
"tax_id": "22222222222",
"email": "jose@email.com",
"address": {
"country": "Brasil",
"region": "São Paulo",
"region_code": "SP",
"city": "Sao Paulo",
"postal_code": "01452002",
"street": "Avenida Brigadeiro Faria Lima",
"number": "1384",
"locality": "Pinheiros"
}
}
}
},
"notification_urls": [
"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
]
}
Após a criação da sua cobrança no modelo mais básico você podem acontecer dois comportamentos diferentes: uma autorização ou uma recusa (negada). Veja abaixo o que isso significa:
Cobrança Criada
Uma cobrança criada no contexto usando forma de pagamento Boleto nada mais é do que o PagSeguro emitindo e registrando o Boleto para que o comprador possa realizar o pagamento. Nesse caso você irá receber o status WAITING, isso indica que o boleto foi gerado e registrado com sucesso e está pronto para pagamento.
Referência API
Abaixo você encontra um exemplo de Boleto emitido, ou seja status WAITING .
{
"id": "CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD",
"reference_id": "ex-00001",
"status": "WAITING",
"created_at": "2019-04-17T20:07:07.002-02",
"description": "Motivo da cobrança",
"amount": {
"value": 1000,
"currency": "BRL",
"summary": {
"total": 1000,
"paid": 0,
"refunded": 0
}
},
"payment_response": {
"code": 20000,
"message": "SUCESSO",
"reference": "071200027526"
},
"payment_method": {
"type": "BOLETO",
"boleto": {
"id": "BOLE_6EA2EB96-CD24-4956-84AB-F4558B6C2097",
"barcode": "03399853012970000000200726101017777550000005100",
"formatted_barcode": "03399.85301 29700.000002 00726.101017 7 77550000005100",
"due_date": "2019-05-08",
"instruction_lines": {
"line_1": "Pagamento processado para DESC Fatura",
"line_2": "Via PagSeguro"
},
"holder": {
"name": "Jose da Silva",
"tax_id": "22222222222",
"email": "jose@email.com",
"address": {
"country": "Brasil",
"region": "São Paulo",
"region_code": "SP",
"city": "Sao Paulo",
"postal_code": "01452002",
"street": "Avenida Brigadeiro Faria Lima",
"number": "1384",
"locality": "Pinheiros"
}
}
}
},
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD",
"media": "application/json",
"type": "GET"
},
{
"rel": "CHARGE.BOLETO",
"href": "https://boleto.digital-payments.pagseguro.com/058e9bf5-8468-41fe-bfae-1bb96dd42b56.pdf",
"media": "application/pdf",
"type": "GET"
},
{
"rel": "CHARGE.BOLETO",
"href": "https://boleto.digital-payments.pagseguro.com/058e9bf5-8468-41fe-bfae-1bb96dd42b56.png",
"media": "application/image",
"type": "GET"
},
{
"rel": "CHARGE.CANCEL",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/cancel",
"media": "application/json",
"type": "POST"
}
],
"notification_url": [
"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
]
}
2. Segundo passo: Tratar a resposta de cobrança
Nessa segunda etapa você deve tratar o retorno da API de Cobrança e dar um feedback amigável ao seu cliente, seja positivo ou negativo.
Para os casos de feedback positivo você pode:
- Compartilhar com o cliente o link do Boleto para impressão no formato que melhor lhe atender (
PNG/PDF); - Compartilhar com o cliente a linha digitável ou o barcode em formato que ele possa copiar e colar, facilitando o uso em seu internet banking ou aplicativo de sua instituição bancária;
Para os casos de feedback negativo você pode:
- Possibilitar ao cliente que refaça a cobrança, seja corrigindo os dados digitados ou usando outra forma de pagamento.
Referência API