--- updatedAt: 2026-08-26T16:31:59.000Z agentTools: projectIndex: https://developer.pagbank.com.br/llms.txt --- # Passo-a-passo - Cobrando com Boleto [block:api-header] { "title": "1. Primeiro passo: Criar uma Cobrança" } [/block] 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: [block:code] { "codes": [ { "code": "{\n \"reference_id\": \"ex-00001\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\"\n },\n \"payment_method\": {\n \"type\": \"BOLETO\",\n \"boleto\": {\n \"due_date\": \"2019-05-08\",\n \"instruction_lines\": {\n \"line_1\": \"Pagamento processado para DESC Fatura\",\n \"line_2\": \"Via PagSeguro\"\n },\n \"holder\": {\n \"name\": \"Jose da Silva\",\n \"tax_id\": \"22222222222\",\n \"email\": \"jose@email.com\",\n \"address\": {\n \"country\": \"Brasil\",\n \"region\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"city\": \"Sao Paulo\",\n \"postal_code\": \"01452002\",\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\"\n }\n }\n }\n },\n \"notification_urls\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ]\n}", "language": "json", "name": "POST: /charges" } ] } [/block] 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. [block:callout] { "type": "info", "body": "[Para detalhes de todos os parâmetros disponíveis nesse recurso consulte nossa Referência API do recurso Cobrança aqui](https://developer.pagbank.com.br/devpagbank/reference/cobranca-criando-uma-cobranca).", "title": "Referência API" } [/block] Abaixo você encontra um exemplo de Boleto emitido, ou seja status `WAITING `. [block:code] { "codes": [ { "code": "{\n \"id\": \"CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"reference_id\": \"ex-00001\",\n \"status\": \"WAITING\",\n \"created_at\": \"2019-04-17T20:07:07.002-02\",\n \"description\": \"Motivo da cobrança\",\n \"amount\": {\n \"value\": 1000,\n \"currency\": \"BRL\",\n \"summary\": {\n \"total\": 1000,\n \"paid\": 0,\n \"refunded\": 0\n }\n },\n \"payment_response\": {\n \"code\": 20000,\n \"message\": \"SUCESSO\",\n \"reference\": \"071200027526\"\n },\n \"payment_method\": {\n \"type\": \"BOLETO\",\n \"boleto\": {\n \"id\": \"BOLE_6EA2EB96-CD24-4956-84AB-F4558B6C2097\",\n \"barcode\": \"03399853012970000000200726101017777550000005100\",\n \"formatted_barcode\": \"03399.85301 29700.000002 00726.101017 7 77550000005100\",\n \"due_date\": \"2019-05-08\",\n \"instruction_lines\": {\n \"line_1\": \"Pagamento processado para DESC Fatura\",\n \"line_2\": \"Via PagSeguro\"\n },\n \"holder\": {\n \"name\": \"Jose da Silva\",\n \"tax_id\": \"22222222222\",\n \"email\": \"jose@email.com\",\n \"address\": {\n \"country\": \"Brasil\",\n \"region\": \"São Paulo\",\n \"region_code\": \"SP\",\n \"city\": \"Sao Paulo\",\n \"postal_code\": \"01452002\",\n \"street\": \"Avenida Brigadeiro Faria Lima\",\n \"number\": \"1384\",\n \"locality\": \"Pinheiros\"\n }\n }\n }\n },\n \"links\": [\n {\n \"rel\": \"SELF\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD\",\n \"media\": \"application/json\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.BOLETO\",\n \"href\": \"https://boleto.digital-payments.pagseguro.com/058e9bf5-8468-41fe-bfae-1bb96dd42b56.pdf\",\n \"media\": \"application/pdf\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.BOLETO\",\n \"href\": \"https://boleto.digital-payments.pagseguro.com/058e9bf5-8468-41fe-bfae-1bb96dd42b56.png\",\n \"media\": \"application/image\",\n \"type\": \"GET\"\n },\n {\n \"rel\": \"CHARGE.CANCEL\",\n \"href\": \"https://sandbox.api.pagseguro.com/charges/CHAR_D32A01A9-92A6-4755-B21D-7B6A1291F7AD/cancel\",\n \"media\": \"application/json\",\n \"type\": \"POST\"\n }\n ],\n \"notification_url\": [\n \"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/\"\n ]\n}", "language": "json", "name": "Cobrança autorizada pela operadora de cartão" } ] } [/block] [block:api-header] { "title": "2. Segundo passo: Tratar a resposta de cobrança" } [/block] 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. [block:callout] { "type": "info", "title": "Referência API", "body": "[Para detalhes de todos os parâmetros disponíveis nesse recurso consulte nossa Referência API do recurso Cobrança aqui](https://developer.pagbank.com.br/devpagbank/reference/cobranca-criando-uma-cobranca)." } [/block]