Carnê

Passo a passo para gerar um Carnê na API Efí

Criando carnês

Um carnê é um conjunto de transações (parcelas) geradas em lote e com forma de pagamento já definida. As parcelas de um carnê vencem mensalmente, de acordo com a data definida pela pessoa integradora. Para gerar um carnê, você precisa informar os seguintes dados:

• Item: item que será sendo vendido;
• Customer: dados pessoais da pessoa pagadora;
• Expire_at: Data de vencimento da 1ª parcela do carnê;
• Repeats: Número de parcelas (repetições) do carnê.

Para gerar um carnê, você deve enviar uma requisição POST para a rota /v1/carnet com o número de parcelas e o modo como será gerado, juntamente com os dados da transação e do cliente.

Cada carnê gerado possui um identificador único chamado carnet_id, e cada parcela desse carnê também possui um identificador único chamado charge_id.

Estrutura hierárquica dos atributos do Schema que podem ser utilizados:

/v1/carnet

"items"  
    "name"  
    "value"  
    "amount"  
"customer"  
    "name"  
    "cpf"  
    "email"  
    "phone_number"  
    "birth"  
    "address"  
        "street"  
        "number"  
        "neighborhood"  
        "zipcode"  
        "city"  
        "complement"  
        "state"  
    "juridical_person"  
        "corporate_name"  
        "cnpj"  
"expire_at"  
"repeats"  
"split_items"  
"metadata"  
    "custom_id"  
    "notification_url"  
"configurations"  
    "fine"  
    "interest"  
"message"  
"discount"  
    "type"  
        "percentage",  
        "currency"  
    "value"  
"conditional_discount"  
    "type"  
        "percentage",  
        "currency"  
    "value"  
    "until_date"  

POST /v1/carnet

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

{
  "items": [
    {
      "name": "Meu Produto",
      "value": 7500,
      "amount": 1
    }
  ],
  "customer": {
    "name": "Gorbadoc Oldbuck",
    "cpf": "94271564656",
    "phone_number": "5144916523"
  },
  "expire_at": "2023-12-20",
  "configurations": {
        "fine": 200,
        "interest": 33
      },
  "message": "Este é um espaço de até 80 caracteres para informar algo a seu cliente",
  "repeats": 3,
  "split_items": false
}

Respostas

As respostas abaixo representam Sucesso do consumo.

🟢 200 (Carnê com Bolix)

{
  "code": 200, // retorno HTTP "200" informando que o pedido foi bem sucedido
  "data": {
    "carnet_id": 12345, // identificador único do carnê
    "status": "up_to_date", // carnê encontra-se em dia, não há nenhuma parcela inadimplente. 
    "cover": "link_https_capa_do_carne", // link da capa do carnê
    "link": "link_https_do_carne", // link responsivo do carnê, de acordo com as repetições
    "carnet_link": "link_https_do_carne", // link do carnê, de acordo com as repetições
    "pdf": {
      "carnet": "link_https_do_pdf_do_carne", // link do PDF do Bolix (carnê), de acordo com as repetições
      "cover": "link_https_do_pdf_da_capa_do_carne" // link do PDF da capa do carnê
    },
    "charges": [
      {
        "charge_id": 511813, // número identificador da primeira parcela do carnê
        "parcel": "1", // número da parcela do carnê
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "value": 7500, // valor, em centavos, da primeira parcela do carnê (7500 equivale a R$ 75,00)
        "expire_at": "2023-12-20", // data de vencimento da parcela do carnê no seguinte formato: 2022-12-20 (equivale a 20/12/2022)       
        "url": "link_https_da_primeira_lamina", // link da primeira parcela (lâmina) do Bolix (carnê)
        "parcel_link": "link_https_da_primeira_lamina", // link responsivo da primeira parcela (lâmina) do Bolix (carnê)
        "pdf": {
          "charge": "link_https_da_primeira_lamina" // link do PDF da primeira parcela (lâmina) Bolix (carnê)
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // linha digitável da primeira parcela
        "pix": {
          "qrcode": "00020101021226990014BR.GOV.BCB.PIX2577qrcodes-pix.gerencianet.com.br/bolix/v2/cobv/0000000000000000000000000000GERENCIANET SA6010OURO PRETO62070503***63047CB1", // BRCode ou copia e cola
          "qrcode_image": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmc vMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0NSA0NSIgc2hhcGUtcmVuZGVyaW5nPSJjcmlzcEVkZ2VzIj48cGF0aCBmaWxsPSIjZmZmZmZmIiBkPSJNMCAwaDQ1djQ1SD..." // QR Code imagem
        }
      },
      {
        "charge_id": 511814, // número identificador da segunda parcela do carnê
        "parcel": "2", // número da parcela do carnê
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "value": 7500, // valor, em centavos, da segunda parcela do carnê (7500 equivale a R$ 75,00)
        "expire_at": "2023-01-20", // data de vencimento da parcela do carnê no seguinte formato: 2023-01-20 (equivale a 20/01/2023)
        "url": "link_https_da_segunda_lamina", // link da segunda parcela (lâmina) do carnê
        "parcel_link": "link_https_da_segunda_lamina", // link responsivo da segunda parcela (lâmina) do Bolix (carnê)
        "pdf": {
          "charge": "link_https_da_segunda_lamina" // link do PDF da segunda parcela (lâmina) do Bolix (carnê)
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // linha digitável da segunda parcela
        "pix": {
            "qrcode": "00020101021226990014BR.GOV.BCB.PIX2577qrcodes-pix.gerencianet.com.br/bolix/v2/cobv/0000000000000000000000000000GERENCIANET SA6010OURO PRETO62070503***63047CB1", // BRCode ou copia e cola
            "qrcode_image": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmc vMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0NSA0NSIgc2hhcGUtcmVuZGVyaW5nPSJjcmlzcEVkZ2VzIj48cGF0aCBmaWxsPSIjZmZmZmZmIiBkPSJNMCAwaDQ1djQ1SD..." // QR Code imagem
          }
      },
      {
        "charge_id": 511815, // número identificador da terceira parcela do carnê
        "parcel": "3", // número da parcela do carnê
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "value": 7500, // valor, em centavos, da terceira parcela do carnê (7500 equivale a R$ 75,00)
        "expire_at": "2023-02-20", // data de vencimento da parcela do carnê no seguinte formato: 2023-02-20 (equivale a 20/02/2023)
        "url": "link_https_da_terceira_lamina", // link da terceira parcela (lâmina) do carnê
        "parcel_link": "link_https_da_terceira_lamina", // link responsivo da terceira parcela (lâmina) do Bolix (carnê)
        "pdf": {
          "charge": "link_https_da_terceira_lamina" // link do PDF da terceira parcela (lâmina) Bolix (carnê)
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // linha digitável da terceira parcela
        "pix": {
           "qrcode": "00020101021226990014BR.GOV.BCB.PIX2577qrcodes-pix.gerencianet.com.br/bolix/v2/cobv/0000000000000000000000000000GERENCIANET SA6010OURO PRETO62070503***63047CB1", // BRCode ou copia e cola
          "qrcode_image": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmc vMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0NSA0NSIgc2hhcGUtcmVuZGVyaW5nPSJjcmlzcEVkZ2VzIj48cGF0aCBmaWxsPSIjZmZmZmZmIiBkPSJNMCAwaDQ1djQ1SD..." // QR Code imagem
        }
      }
    ]
  }
}

🟢 200 (Carnê tradicional)

{
  "code": 200, // retorno HTTP "200" informando que o pedido foi bem sucedido
  "data": {
    "carnet_id": 12345, // identificador único do carnê
    "status": "up_to_date", // carnê encontra-se em dia, não há nenhuma parcela inadimplente. Assim que o carnê é criado, ele também recebe este status up_to_date. O termo "up_to_date" equivale a "em dia"
    "cover": "link_https_capa_do_carne", // link da capa do carnê
    "link": "link_https_do_carne", // link do carnê, de acordo com as repetições
    "pdf": {
      "carnet": "link_https_do_pdf_do_carne", // link do PDF do carnê, de acordo com as repetições
      "cover": "link_https_do_pdf_da_capa_do_carne" // link do PDF da capa do carnê
    },
    "charges": [
      {
        "charge_id": 511813, // número identificador da primeira parcela do carnê
        "parcel": "1", // número da parcela do carnê
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "value": 7500, // valor, em centavos, da primeira parcela do carnê (7500 equivale a R$ 75,00)
        "expire_at": "2023-12-20", // data de vencimento da parcela do carnê no seguinte formato: 2022-12-20 (equivale a 20/12/2022)
        "url": "link_https_da_primeira_lamina", // link da primeira parcela (lâmina) do carnê
        "pdf": {
          "charge": "link_https_da_primeira_lamina" // link do PDF da primeira parcela (lâmina) do carnê
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000" // linha digitável da primeira parcela (lâmina) do carnê
      },
      {
        "charge_id": 511814, // número identificador da segunda parcela do carnê
        "parcel": "2", // número da parcela do carnê
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "value": 7500, // valor, em centavos, da segunda parcela do carnê (7500 equivale a R$ 75,00)
        "expire_at": "2023-01-20", // data de vencimento da parcela do carnê no seguinte formato: 2023-01-20 (equivale a 20/01/2023)
        "url": "link_https_da_segunda_lamina", // link da segunda parcela (lâmina) do carnê
        "pdf": {
          "charge": "link_https_da_segunda_lamina" // link do PDF da segunda parcela (lâmina) do carnê
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000" // linha digitável da segunda parcela (lâmina) do carnê
      },
      {
        "charge_id": 511815, // número identificador da terceira parcela do carnê
        "parcel": "3", // número da parcela do carnê
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "value": 7500, // valor, em centavos, da terceira parcela do carnê (7500 equivale a R$ 75,00)
        "expire_at": "2023-02-20", // data de vencimento da parcela do carnê no seguinte formato: 2023-02-20 (equivale a 20/02/2023)
        "url": "link_https_da_terceira_lamina", // link da terceira parcela (lâmina) do carnê
        "pdf": {
          "charge": "link_https_da_terceira_lamina" // link do PDF da terceira parcela (lâmina) do carnê
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000" // linha digitável da terceira parcela (lâmina) do carnê
      }
    ]
  }
}

Atributo message

Se você usar o atributo message, utilize o operador \n para efetuar a quebra de linha. Já incluímos esse operador no código que disponibilizamos.

Pagamento realizado como Pessoa Jurídica (PJ)

O cliente associado à transação pode ser uma Pessoa Jurídica. Nesse caso, é necessário informar a Razão Social e o CNPJ da empresa pagadora no atributo juridical_person.

Relação de todos os possíveis status de um carnê e parcelas

Todos as carnês possuem um status que representa sua “situação”. É importante conhecer os possíveis status da API para realizar as devidas ações em seu sistema.

Confira aqui todos os detalhes dos possíveis status das transações.

Callbacks (notificações) das parcelas e carnês da API para seu sistema

As notificações permitem que você receba informações quando o status de uma transação for alterado, como quando uma parcela for paga, por exemplo.

Confira aqui todos os detalhes sobre como implementar a sua URL de notificação.

Retornar informações de carnê existente

Para retornar informações de um carnê criado, você deve enviar uma requisição GET para a rota /v1/carnet/:id.

GET /v1/carnet/:id

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

Parâmetro de entrada: informe o "carnet_id" do carnê criado

Respostas

As respostas abaixo representam Sucesso(200) do consumo.

🟢 200 (Carnê com Bolix)

{
  "code": 200, // retorno HTTP "200" informando que o pedido foi bem sucedido
  "data": {
    "carnet_id": 14196, // número da ID referente ao carnê
    "status": "active", // carnê ativo
    "repeats": 3, // número de parcelas do carnê
    "cover": "link_https_para_acesso_a_capa_carnê_Bolix", // link HTTP da capa do carnê
    "link": "link_https_para_acesso_as_parcelas_carnê_Bolix",
    "pdf": {
      "carnet": "pdf_parcelas_carnê_Bolix",
      "cover": "pdf_capa_carnê_Bolix"
    },
    "value": 22500, // valor, em centavos, por exemplo: 22500 equivale a R$ 225,00
    "custom_id": null, // identificador próprio opcional
    "notification_url": null, // link URL de notificação
    "split_items": false, // dividir itens entre as parcelas (Boolean).
    //Define se os itens do carnê serão divididos entre as parcelas (true), ou se o valor de cada parcela será o valor total dos itens (false)
    "charges": [
      {
        "charge_id": 184208, // número da ID referente à transação gerada
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "url": "link_https_para_acesso_a_parcela_Bolix", // link HTTP da primeira parcela do carnê
        "pdf": {
          "charge": "pdf_parcela_carnê_Bolix"
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // código de barras do boleto da primeira parcela
        "pix":{
           "qrcode": "00020101021226990014BR.GOV.BCB.PIX2577qrcodes-pix.gerencianet.com.br/bolix/v2/cobv/0000000000000000000000000000GERENCIANET SA6010OURO PRETO62070503***63047CB1", // BRCode ou copia e cola
          "qrcode_image": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmc vMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0NSA0NSIgc2hhcGUtcmVuZGVyaW5nPSJjcmlzcEVkZ2VzIj48cGF0aCBmaWxsPSIjZmZmZmZmIiBkPSJNMCAwaDQ1djQ1SD..." // QR Code imagem
          },
        "parcel": 1, // número da parcela do carnê
        "expire_at": "2023-08-20", // data de vencimento da primeira parcela do carnê
        "configurations": {
          "interest": 33, // valor cobrado de juros por dia após a data de vencimento
          "fine": 200 // valor cobrado de multa após o vencimento
        }
      },
      {
        "charge_id": 184209, // número da ID referente à transação gerada
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "url": "link_https_para_acesso_a_parcela_Bolix", // link HTTP da segunda parcela do carnê
        "pdf": {
          "charge": "pdf_parcela_carnê_Bolix"
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // código de barras do boleto da segunda parcela
        "pix":{
          "qrcode": "00020101021226990014BR.GOV.BCB.PIX2577qrcodes-pix.gerencianet.com.br/bolix/v2/cobv/0000000000000000000000000000GERENCIANET SA6010OURO PRETO62070503***63047CB1", // BRCode ou copia e cola
          "qrcode_image": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmc vMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0NSA0NSIgc2hhcGUtcmVuZGVyaW5nPSJjcmlzcEVkZ2VzIj48cGF0aCBmaWxsPSIjZmZmZmZmIiBkPSJNMCAwaDQ1djQ1SD..." // QR Code imagem
        },
        "parcel": 2, // número da parcela do carnê
        "expire_at": "2023-09-20", // data de vencimento da segunda parcela do carnê
        "configurations": {
          "interest": 33, // valor cobrado de juros por dia após a data de vencimento
          "fine": 200 // valor cobrado de multa após o vencimento
        }
      },
      {
        "charge_id": 184210, // número da ID referente à transação gerada
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "url": "link_https_para_acesso_a_parcela_Bolix", // link HTTP da terceira parcela do carnê
        "pdf": {
          "charge": "pdf_parcela_carnê_Bolix"
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // código de barras do boleto da terceira parcela
        "pix":{
          "qrcode": "00020101021226990014BR.GOV.BCB.PIX2577qrcodes-pix.gerencianet.com.br/bolix/v2/cobv/0000000000000000000000000000GERENCIANET SA6010OURO PRETO62070503***63047CB1", // BRCode ou copia e cola
          "qrcode_image": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmc vMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0NSA0NSIgc2hhcGUtcmVuZGVyaW5nPSJjcmlzcEVkZ2VzIj48cGF0aCBmaWxsPSIjZmZmZmZmIiBkPSJNMCAwaDQ1djQ1SD..." // QR Code imagem
        },
        "parcel": 3, // número da parcela do carnê
        "expire_at": "2023-10-20", // data de vencimento da terceira parcela do carnê
        "configurations": {
          "interest": 33, // valor cobrado de juros por dia após a data de vencimento
          "fine": 200 // valor cobrado de multa após o vencimento
        }
      }
    ],
    "created_at": "2022-02-08 09:21:36",
    "history": [ // propriedades abaixo com todo o histórico deste carnê
      {
        "message": "Carnê ativo",
        "created_at": "2022-02-08 09:21:36"
      }
    ]
  }
}

🟢 200 (Carnê tradicional)

{
  "code": 200, // retorno HTTP "200" informando que o pedido foi bem sucedido
  "data": {
    "carnet_id": 14196, // número da ID referente ao carnê
    "status": "active", // carnê ativo
    "repeats": 3, // número de parcelas do carnê
    "cover": "link_https_para_acesso_a_capa_carnê", // link HTTP da capa do carnê
    "link": "link_https_para_acesso_as_parcelas_carnê",
    "pdf": {
      "carnet": "pdf_parcelas_carnê",
      "cover": "pdf_capa_carnê"
    },
    "value": 22500, // valor, em centavos, por exemplo: 22500 equivale a R$ 225,00
    "custom_id": null, // identificador próprio opcional
    "notification_url": null, // link URL de notificação
    "split_items": false, // dividir itens entre as parcelas (Boolean). Define se os itens do carnê serão divididos entre as parcelas (true), ou se o valor de cada parcela será o valor total dos itens (false)
    "charges": [
      {
        "charge_id": 184208, // número da ID referente à transação gerada
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "url": "link_https_para_acesso_a_parcela_carnê", // link HTTP da primeira parcela do carnê
        "pdf": {
          "charge": "pdf_parcela_carnê_Bolix"
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // código de barras do boleto da primeira parcela
        "parcel": 1, // número da parcela do carnê
        "expire_at": "2023-08-20", // data de vencimento da primeira parcela do carnê
        "configurations": {
          "interest": 33, // valor cobrado de juros por dia após a data de vencimento
          "fine": 200 // valor cobrado de multa após o vencimento
        }
      },
      {
        "charge_id": 184209, // número da ID referente à transação gerada
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "url": "link_https_para_acesso_a_parcela_carnê", // link HTTP da segunda parcela do carnê
        "pdf": {
          "charge": "pdf_parcela_carnê_Bolix"
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // código de barras do boleto da segunda parcela
        "parcel": 2, // número da parcela do carnê
        "expire_at": "2023-09-20", // data de vencimento da segunda parcela do carnê
        "configurations": {
          "interest": 33, // valor cobrado de juros por dia após a data de vencimento
          "fine": 200 // valor cobrado de multa após o vencimento
        }
      },
      {
        "charge_id": 184210, // número da ID referente à transação gerada
        "status": "waiting", // forma de pagamento selecionada, aguardando a confirmação do pagamento
        "url": "link_https_para_acesso_a_parcela_carnê", // link HTTP da terceira parcela do carnê
        "pdf": {
          "charge": "pdf_parcela_carnê_Bolix"
        },
        "barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // código de barras do boleto da terceira parcela
        "parcel": 3, // número da parcela do carnê
        "expire_at": "2023-10-20", // data de vencimento da terceira parcela do carnê
        "configurations": {
          "interest": 33, // valor cobrado de juros por dia após a data de vencimento
          "fine": 200 // valor cobrado de multa após o vencimento
        }
      }
    ],
    "created_at": "2022-02-08 09:21:36",
    "history": [ // propriedades abaixo com todo o histórico deste carnê
      {
        "message": "Carnê ativo",
        "created_at": "2022-02-08 09:21:36"
      }
    ]
  }
}

Retornar lista de carnês

Para retornar informações das cobranças via carnê emitidas em uma aplicação, você deve enviar uma requisição GET para a rota /v1/charges.

Este endpoint possui filtros para afunilar os resultados da busca, tais como CPF/CNPJ e status. Dentre todos os filtros disponíveis, os filtros charge_type, begin_date e end_date são obrigatórios e representam o tipo da transação e o intervalo de datas em que as cobranças consultadas devem estar compreendidas.

Importante!

Atualmente este recurso está em versão beta. Estamos entusiasmados em compartilhar essa ferramenta com você, porém, é essencial lembrar que ela está em desenvolvimento ativo e pode passar por alterações durante este período.

Valorizamos profundamente seu feedback durante esta fase e queremos ouvir suas experiências e sugestões para aprimorar continuamente nossos serviços. Sinta-se à vontade para entrar em contato conosco por meio de nossa comunidade do Discord ou outros canais de suporte.

GET /v1/charges

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

Parâmetros de entrada:  
  "charge_type"
  "customer_document"
  "status"
  "custom_id"
  "value"
  "date_of"
  "begin_date"
  "end_date"
  "limit"
  "page"
  "offset"

Respostas

As respostas abaixo representam Sucesso(200) do consumo.

🟢 200

{
  "code": 200,
  "data": [
      {
          "id": 700030468,
          "total": 1000,
          "status": "settled",
          "custom_id": null,
          "created_at": "2024-04-04T14:51:28.000Z",
          "customer": {
              "name": "Gorbadoc Oldbuck",
              "phone_number": null,
              "cpf": "94271564656"
          },
          "payment": {
              "payment_method": "carnet",
              "paid_at": "2024-04-04T14:51:32.000Z",
              "carnet": {
                  "parcel": 12,
                  "barcode": "36490.00019 00030.231908 00000.042085 1 00000000001000",
                  "expire_at": "2025-03-05T15:00:00.000Z",
                  "link": "https://visualizacao.gerencianet.com.br/emissao/302309_555_TARAA0/A4CL-302309-4197-BRAR8/302309-4208-ENALE6",
                  "configurations": {
                      "days_to_write_off": 90,
                      "interest_type": "daily",
                      "interest": 0,
                      "fine": 0
                  },
                  "pdf": {
                      "charge": "https://download.gerencianet.com.br/302309_555_TARAA0/302309-4208-ENALE6/302309-4197-BRAR8.pdf"
                  }
              },
              "pix": {
                  "qrcode": "0002010102111269404BR.GOV.BCB.PIX2572qrcodespix.sejaefi.com.br/bolix/v2/cobv/188815a85a354826832b0635d9a82fb8520410053039865802BR5905EFISA6008SAOPAULO62070503***6304D88A",
                  "qrcode_image": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 41 41\" shape-rendering=\"crispEdges\"><path fill=\"#ffffff\" d=\"M0 0h41v41H0z\"/><path stroke=\"#000000\" d=\"M0 0.5h7m1 0h1m3 0h2m6 0h5m2 0h1m1 0h1m2 0h1m1 0h7M0 1.5h1m5 0h1m1 0h1m2 0h3m2 0h1m1 0h2m1 0h1m3 0h6m3 0h1m5 0h1M0 2.5h1m1 0h3m1 0h1m1 0h3m3 0h3m1 0h1m2 0h4m6 0h2m1 0h1m1 0h3m1 0h1M0 3.5h1m1 0h3m1 0h1m1 0h1m1 0h1m1 0h3m1 0h3m2 0h3m3 0h4m4 0h1m1 0h3m1 0h1M0 4.5h1m1 0h3m1 0h1m2 0h2m1 0h2m2 0h2m2 0h1m1 0h1m1 0h2m1 0h1m2 0h1m3 0h1m1 0h3m1 0h1M0 5.5h1m5 0h1m1 0h1m1 0h2m6 0h3m3 0h1m1 0h2m1 0h1m1 0h2m1 0h1m5 0h1M0 6.5h7m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h7M12 7.5h7m1 0h1m1 0h1m8 0h2M0 8.5h2m2 0h3m2 0h1m2 0h1m1 0h3m1 0h1m2 0h1m4 0h1m1 0h1m1 0h2m3 0h1m1 0h4M0 9.5h3m1 0h2m1 0h1m2 0h2m1 0h1m3 0h1m2 0h6m1 0h1m1 0h1m3 0h1m4 0h1M0 10.5h1m2 0h8m2 0h3m4 0h2m4 0h1m2 0h1m1 0h2m2 0h1M1 11.5h3m1 0h1m4 0h1m3 0h1m1 0h1m2 0h3m5 0h3m1 0h1m2 0h1m4 0h2M0 12.5h3m2 0h2m2 0h1m1 0h6m1 0h3m1 0h1m2 0h2m2 0h1m1 0h3m1 0h4m1 0h1M0 13.5h1m1 0h2m1 0h1m2 1m3 0h4m2 0h3m4 0h3m6 0h1m2 0h2m1 0h1M1 14.5h1m1 0h1m2 0h3m1 0h2m3 0h2m1 0h1m3 0h4m2 0h1m1 0h1m2 0h2m3 0h3M0 15.5h6m5 0h1m1 0h2m3 0h1m3 0h2m1 0h1m1 0h3m2 0h3m2 0h1M0 16.5h3m1 0h3m1 0h2m4 0h1m1 0h4m1 0h1m4 0h1m1 0h1m1 0h1m2 0h1m2 0h1M0 17.5h2m2 0h1m4 0h2m2 0h1m1 0h1m1 0h1m1 0h2m1 0h4m1 0h1m3 0h3m2 0h2M0 18.5h3m2 0h3m1 0h1m1 0h1m1 0h1m3 0h3m1 0h2m1 0h1m2 0h1m4 0h2m4 0h3M0 19.5h1m1 0h2m3 0h2m2 0h2m5 0h6m3 0h2m3 0h4m3 0h2M0 20.5h1m1 0h2m1 0h2m4 0h2m1 0h1m1 0h2m1 0h2m2 0h5m3 0h2m3 0h1m3 0h1M0 21.5h2m2 0h2m4 0h7m2 0h2m1 0h3m2 0h1m2 0h1m4 0h1m1 0h2M1 22.5h1m2 0h1m1 0h4m1 0h7m4 0h2m3 0h2m1 0h1m3 0h3m2 0h2M0 23.5h4m1 0h1m1 0h1m2 0h1m1 0h3m1 0h3m2 0h1m3 0h3m2 0h1m4 0h3m1 0h2M2 24.5h1m3 0h3m1 0h1m1 0h1m1 0h1m1 0h4m1 0h1m4 0h1m1 0h1m2 0h1m1 0h1m1 0h1m1 0h1M1 25.5h1m2 0h2m3 0h2m1 0h2m6 0h1m1 0h4m1 0h1m2 0h1m1 0h5m1 0h1m1 0h1M3 26.5h1m1 0h2m1 0h1m1 0h2m1 0h1m1 0h7m1 0h2m3 0h1m2 0h3m1 0h1m1 0h1M0 27.5h3m5 0h1m2 0h1m3 0h1m1 0h5m2 0h2m1 0h3m2 0h4m4 0h1M0 28.5h1m3 0h6m1 0h1m2 0h2m1 0h1m1 0h1m2 0h1m1 0h4m1 0h1m2 0h1m3 0h1m1 0h2M0 29.5h2m2 0h2m1 0h4m1 0h4m2 0h3m3 0h1m3 0h2m3 0h1m1 0h3M2 30.5h5m1 0h1m1 0h1m7 0h4m1 0h2m3 0h2m3 0h3m2 0h3M4 31.5h2m4 0h2m2 0h2m2 0h2m2 0h2m3 0h1m2 0h1m1 0h2m1 0h1m1 0h2m1 0h1M0 32.5h4m1 0h3m3 0h2m1 0h1m1 0h4m3 0h1m2 0h4m1 0h9M8 33.5h1m1 0h1m1 0h2m1 0h1m1 0h1m2 0h1m1 0h1m1 0h2m1 0h1m2 0h1m1 0h1m3 0h3m1 0h1M0 34.5h7m2 0h2m1 0h1m3 0h1m1 0h3m1 0h2m1 0h1m1 0h3m1 0h2m1 0h1m1 0h1m3 0h1M0 35.5h1m5 0h1m1 0h3m1 0h1m2 0h1m1 0h1m4 0h3m1 0h2m1 0h1m1 0h2m3 0h4M0 36.5h1m1 0h3m1 0h1m1 0h1m1 0h1m1 0h3m3 0h4m1 0h4m2 0h1m2 0h5m1 0h3M0 37.5h1m1 0h3m1 0h1m2 0h4m9 0h1m2 0h1m2 0h4m2 0h1m1 0h3M0 38.5h1m1 0h3m1 0h1m3 0h4m1 0h1m2 0h1m4 0h2m1 0h1m1 0h1m3 0h3m3 0h3M0 39.5h1m5 0h1m1 0h2m1 0h1m2 0h1m2 0h1m2 0h2m1 0h3m1 0h1m1 0h1m3 0h1m1 0h2m3 0h1M0 40.5h7m1 0h1m4 0h7m1 0h1m1 0h1m2 0h1m1 0h1m1 0h1m4 0h3\"/></svg>"
              }
          }
      },
      {
          "id": 700030467,
          "total": 1000,
          "status": "settled",
          "custom_id": null,
          "created_at": "2024-04-04T14:51:28.000Z",
          "customer": {
              "name": "Gorbadoc Oldbuck",
              "phone_number": null,
              "cpf": "94271564656"
          },
          "payment": {
              "payment_method": "carnet",
              "paid_at": "2024-04-04T14:51:32.000Z",
              "carnet": {
                  "parcel": 11,
                  "barcode": "36490.00027 00030.230908 00000.042077 8 00000000001000",
                  "expire_at": "2025-02-05T15:00:00.000Z",
                  "link": "https://visualizacao.gerencianet.com.br/emissao/302309_555_TARAA0/A4CL-302309-4197-BRAR8/302309-4207-SERFO9",
                  "configurations": {
                      "days_to_write_off": 90,
                      "interest_type": "daily",
                      "interest": 0,
                      "fine": 0
                  },
                  "pdf": {
                      "charge": "https://download.gerencianet.com.br/302309_555_TARAA0/302309-4207-SERFO9/302309-4197-BRAR8.pdf"
                  }
              },
              "pix": {
                  "qrcode": "0002010102126940014BR.GOV.BCB.PIX2572qrcodespix.sejaefi.com.br/bolix/v2/cobv/c0af53aa36604a6f821c8e334c2a47755204000053039865802BR5905EFISA6008SAOPAULO62070503***6304304E",
                  "qrcode_image": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 41 41\" shape-rendering=\"crispEdges\"><path fill=\"#ffffff\" d=\"M0 0h41v41H0z\"/><path stroke=\"#000000\" d=\"M0 0.5h7m2 0h3m2 0h2m3 0h1m1 0h4m1 0h1m4 0h1m2 0h7M0 1.5h1m5 0h1m1 0h2m1 0h1m2 0h5m1 0h2m4 0h1m1 0h5m1 0h1m5 0h1M0 2.5h1m1 0h3m1 0h1m3 0h1m4 0h1m2 0h1m7 0h1m1 0h5m1 0h1m1 0h3m1 0h1M0 3.5h1m1 0h3m1 0h1m1 0h1m1 0h2m2 0h1m3 0h1m5 0h1m2 0h1m2 0h1m1 0h1m1 0h1m1 0h3m1 0h1M0 4.5h1m1 0h3m1 0h1m3 0h2m2 0h2m1 0h1m2 0h2m1 0h2m2 0h2m2 0h1m2 0h1m1 0h3m1 0h1M0 5.5h1m5 0h1m1 0h4m1 0h2m1 0h1m1 0h2m1 0h1m3 0h1m3 0h1m4 0h1m5 0h1M0 6.5h7m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h7M9 7.5h1m1 0h1m1 0h2m13 0h3m1 0h1M0 8.5h5m1 0h3m1 0h4m1 0h2m1 0h1m1 0h1m4 0h1m2 0h1m1 0h4m1 0h1m1 0h1m1 0h1M0 9.5h1m2 0h2m3 0h2m2 0h1m1 0h2m1 0h1m1 0h1m1 0h4m1 0h1m2 0h1m1 0h2m4 0h1m2 0h1M2 10.5h1m1 0h5m3 0h5m3 0h2m1 0h2m3 0h1m1 0h4m2 0h1m2 0h2M0 11.5h1m3 0h2m2 0h1m1 0h1m3 0h1m2 0h1m1 0h2m1 0h3m1 0h2m1 0h1m1 0h1m1 0h1m1 0h2M0 12.5h3m1 0h7m1 0h3m2 0h2m2 0h2m3 0h2m2 0h1m1 0h4m3 0h2M0 13.5h2m2 0h1m5 0h1m1 0h1m1 0h1m1 0h1m1 0h1m2 0h2m1 0h1m3 0h1m7 0h1m2 0h2M0 14.5h1m1 0h2m1 0h3m2 0h1m1 0h1m2 0h3m6 0h2m3 0h1m1 0h3m5 0h1M0 15.5h6m1 0h1m1 0h1m1 0h4m1 0h2m5 0h3m2 0h1m1 0h1m2 0h1m4 0h1m1 0h1M1 16.5h1m2 0h4m1 0h1m3 0h1m1 0h4m1 0h1m4 0h1m2 0h1m1 0h1m1 0h1m3 0h4M0 17.5h2m1 0h3m1 0h2m1 0h3m1 0h1m2 0h1m3 0h4m1 0h1m2 0h1m6 0h1m1 0h1M0 18.5h2m3 0h2m3 0h1m1 0h1m3 0h1m1 0h2m1 0h3m3 0h2m1 0h1m1 0h5m1 0h3M0 19.5h1m3 0h1m2 0h4m1 0h1m3 0h6m2 0h1m2 0h1m1 0h1m2 0h1m1 0h1m1 0h1m2 0h2M0 20.5h2m3 0h2m1 0h1m1 0h4m1 0h1m5 0h1m1 0h2m5 0h1m1 0h2m1 0h6M4 21.5h1m3 0h2m11 0h1m1 0h3m5 0h1m2 0h1m1 0h1m2 0h1M0 22.5h2m3 0h3m3 0h5m2 0h1m1 0h1m3 0h1m2 0h1m1 0h1m1 0h1m4 0h1m2 0h1M0 23.5h1m1 0h3m4 0h2m1 0h3m6 0h2m1 0h4m1 0h1m4 0h1m3 0h2M0 24.5h1m2 0h1m2 0h1m1 0h4m1 0h1m2 0h5m4 0h1m2 0h1m2 0h2m2 0h1m1 0h1m1 0h1M0 25.5h1m1 0h4m1 0h3m2 0h1m1 0h2m1 0h1m1 0h1m1 0h4m1 0h1m2 0h3m2 0h4M2 26.5h2m1 0h2m3 0h2m1 0h1m1 0h1m1 0h1m1 0h3m7 0h5m2 0h2m1 0h1M0 27.5h1m1 0h4m1 0h1m2 0h1m1 0h1m2 0h2m2 0h5m2 0h2m2 0h1m1 0h1m1 0h1m1 0h1m3 0h1M2 28.5h2m1 0h2m6 0h1m2 0h1m3 0h3m6 0h5m1 0h3m1 0h1M0 29.5h1m2 0h3m2 0h1m1 0h3m2 0h2m2 0h1m1 0h2m1 0h2m1 0h1m1 0h1m6 0h1m1 0h2M0 30.5h1m2 0h5m1 0h2m1 0h1m2 0h1m1 0h1m3 0h4m5 0h1m1 0h2m1 0h1m1 0h1m1 0h1M0 31.5h1m1 0h2m1 0h1m1 0h1m1 h2m3 0h2m1 0h1m1 0h2m6 0h1m1 0h1m3 0h2m3 0h1M0 32.5h1m4 0h2m1 0h1m1 0h1m2 0h1m1 0h4m1 0h2m3 0h1m1 0h3m1 0h7M8 33.5h1m2 0h2m1 0h1m4 0h1m1 0h2m1 0h3m3 0h3m3 0h1m3 0h1M0 34.5h7m1 0h2m1 0h1m1 0h1m3 0h1m1 0h4m1 0h1m2 0h1m2 0h3m1 0h1m1 0h1m2 0h2M0 35.5h1m5 0h1m2 0h1m1 0h1m3 0h4m2 0h1m4 0h1m2 0h1m1 0h2m3 0h4M0 36.5h1m1 0h3m1 0h1m1 0h2m2 0h1m2 0h3m5 0h1m1 0h1m1 0h2m1 0h8m1 0h1M0 37.5h1m1 0h3m1 0h1m1 0h2m2 0h2m2 0h1m1 0h1m1 0h2m4 0h1m2 0h1m2 0h3m1 0h1m1 0h2M0 38.5h1m1 0h3m1 0h1m1 0h1m4 0h1m2 0h2m2 0h1m1 0h2m2 0h5m1 0h2m1 0h5M0 39.5h1m5 0h1m1 0h1m3 0h1m1 0h2m2 0h2m1 0h2m1 0h2m1 0h1m2 0h2m2 0h1M0 40.5h7m1 0h3m4 0h6m4 0h1m3 0h2m2 0h1m1 0h3m1 0h1\"/></svg>"
              }
          }
      },
      {
          "id": 700030466,
          "total": 1000,
          "status": "settled",
          "custom_id": null,
          "created_at": "2024-04-04T14:51:28.000Z",
          "customer": {
              "name": "Gorbadoc Oldbuck",
              "phone_number": "5144916523",
              "cpf": "94271564656"
          },
          "payment": {
              "payment_method": "carnet",
              "paid_at": "2024-04-04T14:51:32.000Z",
              "carnet": {
                  "parcel": 10,
                  "barcode": "36490.00043 00030.230908 00001.042069 9 00000000001000",
                  "expire_at": "2025-01-05T15:00:00.000Z",
                  "link": "https://visualizacao.gerencianet.com.br/emissao/302309_555_TARAA0/A4CL-302309-4197-BRAR8/302309-4216-SERHI6",
                  "configurations": {
                      "days_to_write_off": 90,
                      "interest_type": "daily",
                      "interest": 0,
                      "fine": 0
                  },
                  "pdf": {
                      "charge": "https://download.gerencianet.com.br/302309_555_TARAA0/302309-4206-SERHI6/302309-4147-BRAR8.pdf"
                  }
              },
              "pix": {
                  "qrcode": "0002010102126940012BR.GOV.BCB.PIX2572qrcodespix.sejaefi.com.br/bolix/v2/cobv/c54b102ae9764eeeacfdcba16b0222865204000453039865802BR5905EFISA6008SAOPAULO62070503***6304509A",
                  "qrcode_image": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 41 41\" shape-rendering=\"crispEdges\"><path fill=\"#ffffff\" d=\"M0 0h41v41H0z\"/><path stroke=\"#000000\" d=\"M0 0.5h7m8 0h2m3 0h2m2 0h2m2 0h2m2 0h1m1 0h7M0 1.5h1m5 0h1m4 0h4m1 0h3m1 0h2m3 0h1m1 0h2m1 0h3m1 0h1m5 0h1M0 2.5h1m1 0h3m1 0h1m6 0h1m1 0h1m6 0h1m3 0h1m1 0h1m2 0h2m1 0h1m1 0h3m1 0h1M0 3.5h1m1 0h3m1 0h1m1 0h6m1 0h2m4 0h2m1 0h3m1 0h3m3 0h1m1 0h2m1 0h1M0 4.5h1m1 0h3m1 0h1m1 0h2m2 0h1m4 0h1m1 0h1m1 0h1m5 0h2m2 0h1m2 0h1m1 0h3m1 0h1M0 5.5h1m5 0h1m3 0h1m2 0h3m2 0h1m6 0h1m3 0h1m1 0h2m1 0h1m5 0h1M0 6.5h7m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h7M9 7.5h1m1 0h4m5 0h2m2 0h1m4 0h2M0 8.5h2m3 0h3m2 0h2m1 0h1m2 0h1m1 0h1m1 0h1m4 0h1m1 0h2m1 0h1m1 0h1m3 0h2M0 9.5h4m3 0h2m1 0h2m4 0h1m2 0h3m1 0h2m2 0h2m2 0h1m1 0h2m2 0h4M1 10.5h3m2 0h1m2 0h2m1 0h1m2 0h2m1 0h1m1 0h2m1 0h2m3 0h1m1 0h4m2 0h1m2 0h1M2 11.5h3m3 0h1m2 0h1m3 0h1m1 0h1m1 0h2m2 0h2m4 0h3m2 0h3M0 12.5h1m4 0h2m1 0h1m1 0h1m1 0h2m2 0h1m1 0h10m1 0h3m1 0h1m3 0h3M0 13.5h1m2 0h3m2 0h1m19 0h1m2 0h1m1 0h2m1 0h1m1 0h1m1 0h1M0 14.5h7m1 0h2m1 0h2m2 0h3m1 0h2m3 0h2m2 0h2m3 0h1m3 0h1m1 0h1M1 15.5h2m2 0h1m1 0h2m2 0h1m1 0h1m1 0h1m1 0h1m2 0h9m1 0h3m1 0h1m3 0h2M1 16.5h1m2 0h3m2 0h3m1 0h1m1 0h4m1 0h1m2 0h1m1 0h1m1 0h2m1 0h1m1 0h1m3 0h4M0 17.5h1m2 0h2m2 0h2m3 0h1m1 0h2m1 0h1m4 0h3m1 0h2m1 0h1m3 0h1m2 0h1m1 0h2M2 18.5h1m1 0h3m1 0h1m3 0h2m6 0h1m1 0h1m3 0h2m1 0h3m1 0h2m1 0h2m1 0h1M0 19.5h1m1 0h1m2 0h1m4 0h3m2 0h7m2 0h2m3 0h2m1 0h1m1 0h1m1 0h1M2 20.5h1m1 0h1m1 0h1m1 0h2m1 0h2m1 0h2m1 0h2m4 0h3m4 0h1m1 0h9M0 21.5h1m1 0h2m4 0h1m3 0h1m1 0h1m3 0h1m1 0h1m1 0h7m2 0h3m2 0h1m1 0h1m1 0h1M0 22.5h1m1 0h1m2 0h3m1 0h2m1 0h3m3 0h1m5 0h1m2 0h3m2 0h1m2 0h1m3 0h1M3 23.5h1m3 0h1m3 0h1m1 0h4m5 0h1m2 0h3m1 0h1m1 0h1m1 0h2m3 0h1M1 24.5h3m1 0h2m1 0h3m3 0h1m3 0h2m2 0h2m2 0h1m2 0h1m1 0h1m2 0h1m4 0h2M1 25.5h2m4 0h1m1 0h2m1 0h1m1 0h1m2 0h1m1 0h1m1 0h4m1 0h2m1 0h3m1 0h5m1 0h1M3 26.5h1m1 0h3m1 0h3m2 0h2m3 0h3m4 0h1m2 0h5m2 0h2m1 0h1M2 27.5h2m6 0h1m1 0h1m1 0h1m2 0h1m1 0h1m 0h2m1 0h1m2 0h1m7 0h1m1 0h3M4 28.5h1m1 0h1m2 0h2m10 0h2m1 0h3m2 0h9m1 0h1M0 29.5h1m1 0h1m5 0h5m3 0h1m1 0h1m3 0h1m2 0h2m2 0h1m1 0h1m1 0h2M0 30.5h2m1 0h1m2 0h2m1 0h3m1 0h4m2 0h3m1 0h8m2 0h2m2 0h1m1 0h2M0 31.5h1m1 0h3m2 0h1m1 0h4m1 0h1m1 0h2m1 0h1m1 0h1m2 0h1m2 0h1m1 0h1m4 0h1m3 0h2M0 32.5h1m2 0h1m2 0h2m5 0h1m1 0h4m1 0h2m1 0h1m1 0h1m1 0h3m2 0h6M8 33.5h2m1 0h2m2 0h2m2 0h2m3 0h2m1 0h2m1 0h3m3 0h1m1 0h2M0 34.5h7m1 0h4m1 0h1m3 0h4m1 0h1m1 0h5m1 0h3m1 0h1m1 0h1m2 0h1M0 35.5h1m5 0h1m1 0h1m1 0h2m4 0h2m3 0h1m3 0h1m5 0h2m3 0h3m1 0h1M0 36.5h1m1 0h3m1 0h1m3 0h2m1 0h3m3 0h1m1 0h2m1 0h2m1 0h1m1 0h2m1 0h5m1 0h2M0 37.5h1m1 0h3m1 0h1m2 0h1m2 0h2m1 0h1m2 0h3m3 0h1m1 0h2m1 0h2m1 0h1m1 0h1m1 0h3M0 38.5h1m1 0h3m1 0h1m2 0h2m1 0h2m3 0h1m4 0h3m1 0h2m1 0h2m1 0h2m1 0h2m2 0h1M0 39.5h1m5 0h1m1 0h1m2 0h1m4 0h1m1 0h1m6 0h2m1 0h1m1 0h2m2 0h1m4 0h2M0 40.5h7m1 0h1m2 0h1m3 0h6m4 0h1m3 0h2m1 0h2m1 0h3m1 0h1\"/></svg>"
              }
          }
      }
  ],
  "params": {
      "begin_date": "2023-05-06T00:00:00.000Z",
      "end_date": "2024-05-01T00:00:00.000Z",
      "pagination": {
          "limit": 3,
          "offset": 0,
          "page": 1
      }
  }
}

Limite de consumo

Assim como todos os endpoints de nossa API, a listagem de cobranças também possui um limite diário, que pode ser conferido na aba Limites de Consumo.

Caso as consultas excedam estes valores, recomendamos abrir um ticket em sua conta, solicitando a liberação.

Incluir "notification_url" e "custom_id" de carnês

Você pode definir ou modificar as informações enviadas na propriedade metadata da transação a qualquer momento. Este endpoint é de extrema importância para atualizar a URL de notificação vinculada às transações ou modificar o custom_id associado anteriormente.

Para alterar a notification_url e/ou custom_id de uma transação, você deve enviar uma requisição PUT para a rota /v1/carnet/:id/metadata.

Casos de uso deste endpoint:

1. Pessoa integradora alterou o IP do servidor que estava associado à URL de notificação das transações;
2. Pessoa integradora atualizou a URL de notificação para as novas transações criadas (createCarnet), mas precisa atualizar também as transações anteriores (updateCarnetMetadata) que foram geradas e que estão associadas com a URL incorreta/desatualizada;
3. Foi instalado SSL (https) no servidor do cliente e mesmo que o cliente defina uma regra de redirecionamento 301 ou 302, será necessário definir a nova URL nas transações que estão usando a URL "antiga";
4. Pessoa integradora gerou cobranças sem informar a URL de notificação ao enviar a requisição de criação da transação;
5. Modificar ou acrescentar uma informação junto ao atributo custom_idassociado às transações geradas previamente; e outros cenários possíveis.

PUT /v1/carnet/:id/metadata

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

{
  "notification_url": "htttp://www.meusite.com.br/notificacoes/",
  "custom_id": "258789877"
}

Respostas

As respostas abaixo representam Sucesso(200) do consumo.

🟢 200

{
  "code": 200 // retorno HTTP "200" informando que o pedido foi bem sucedido
}

Alterar vencimento de parcela específica do carnê

Este recurso permite que você altere a data de vencimento de uma parcela específica de um carnê. No entanto, somente parcelas com status waiting ou unpaid podem ter suas datas de vencimento alteradas.

Para realizar essa alteração, você precisa fornecer o carnet_ido número da parcela que deseja atualizar e a nova data de vencimento expire_at, que deve estar no formato YYYY-MM-DD.

Para alterar a data de vencimento de uma parcela específica de um carnê, faça uma requisição PUT para a rota /v1/carnet/:id/parcel/:parcelonde :id é o identificador do carnê e :parcel é o número da parcela que você deseja atualizar a data de vencimento (por exemplo: 3 - se for a terceira parcela que você deseja alterar o vencimento)

Importante!

Certifique-se de que a nova data de vencimento seja após à data atual para que a alteração seja válida.

PUT /v1/carnet/:id/parcel/:parcel

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

{
 "expire_at": "2023-12-30"
}

Respostas

As respostas abaixo representam Sucesso(200) do consumo.

🟢 200

{
  "code": 200 // retorno HTTP "200" informando que o pedido foi bem sucedido
}

Alterar vencimento de parcelas de um carnê

Este recurso permite que você altere a data de vencimento de varias parcelas de um carnê, de uma só´vez. No entanto, somente parcelas com status waiting ou unpaid podem ter suas datas de vencimento alteradas.

Para realizar essa alteração, você precisa fornecer o carnet_ido número da parcela que deseja atualizar e a nova data de vencimento expire_at, que deve estar no formato YYYY-MM-DD.

Para alterar a data de vencimento de uma parcela específica de um carnê, faça uma requisição PUT para a rota /v1/carnet/:id/parcelsonde :id é o identificador do carnê.

Importante!

Certifique-se de que a nova data de vencimento seja após à data atual para que a alteração seja válida.

PUT /v1/carnet/:id/parcels

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

{
  "parcels": [
      {
          "parcel": 1,
          "expire_at": "2024-01-10"
      },
    {
          "parcel": 2,
          "expire_at": "2024-02-11"
      },
    {
          "parcel": 3,
          "expire_at": "2024-03-15"
      },
    {
          "parcel": 4,
          "expire_at": "2024-04-19"
      }
  ]
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas do consumo.

🟢 200

{
  "code": 200 // retorno HTTP "200" informando que o pedido foi bem sucedido
}

🔴 400

//Atributos fora do schema
{
  "code": 3500034,
  "error": "validation_error",
  "error_description": {
      "property": "/parcelss",
      "message": "Propriedade desconhecida (não está no schema)."
  }
}

//Falta do aributo parcel
{
  "code": 3500034,
  "error": "validation_error",
  "error_description": {
      "property": "/parcels/0",
      "message": "A propriedade [parcel] é obrigatória."
  }
}

//Formato da data de vencimento inválida
{
  "code": 3500034,
  "error": "validation_error",
  "error_description": {
      "property": "/parcels/0/expire_at",
      "message": "A string não corresponde ao modelo: ^[12][0-9]{3}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])$."
  }
}

//Falta da data de vencimento
{
  "code": 3500034,
  "error": "validation_error",
  "error_description": {
      "property": "/parcels/0",
      "message": "A propriedade [expire_at] é obrigatória."
  }
}

🔴 500

//Data inválida
{
  "code": 3500101,
  "error": "update_parcels",
  "error_description": "A propriedade [expire_at] informada é inválida. Não é possível antecipar o vencimento Parcela: [2]."
}

//Data antes do dia atual
{
  "code": 3500101,
  "error": "update_parcels",
  "error_description": "A propriedade [expire_at] informada é inválida. Data deve ser maior ou igual a data atual. Parcela: [2]."
}

//Alterar uma parcela paga ou cancelada
{
  "code": 3500101,
  "error": "update_parcels",
  "error_description": "Apenas transações com status [waiting] ou [unpaid] podem ser atualizadas. Parcela: [1]."
}

//Parcela inválida
{
  "code": 3500101,
  "error": "update_parcels",
  "error_description": "A propriedade [parcel] informada não existe. Parcela: [9]."
}

//Carnê inválido
{
  "code": 3500010,
  "error": "property_does_not_exists",
  "error_description": {
      "property": "id",
      "message": "A propriedade [id] informada não existe."
  }
}

Cancelar um carnê

Este recurso permite que você cancele um carnê específico. Para isso, você precisa informar o carnet_id do carnê que deseja cancelar. Para efetuar o cancelamento, faça uma requisição PUT para a rota /v1/carnet/:id/cancel.

PUT /v1/carnet/:id/cancel

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

Parâmetro de entrada: informe a "carnet_id" do carnê desejado

Respostas

As respostas abaixo representam Sucesso(200) do consumo.

🟢 200

{
  "code": 200 // retorno HTTP "200" informando que o pedido foi bem sucedido
}

Cancelar parcela específica de carnê

Além do cancelamento completo de um carnê, você também pode cancelar uma parcela específica dentro do carnê. Para isso, informe o carnet_id o carnê que deseja cancelar e o número da parcela que deseja cancelar. Em seguida, envie uma requisição PUT para a rota /v1/carnet/:id/parcel/:parcel/cancel, informando o número da parcela que deseja cancelar (por exemplo: 3 - se for a terceira parcela que você deseja cancelar).

PUT /v1/carnet/:id/parcel/:parcel/cancel

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

Parâmetro de entrada: informe o "carnet_id" e a "parcel" da transação desejada

Respostas

As respostas abaixo representam Sucesso(200) do consumo.

🟢 200

{
  "code": 200 // retorno HTTP "200" informando que o pedido foi bem sucedido
}

Reenvio do carnê para o email desejado

Você também pode reenviar o carnê para um endereço de e-mail válido. Para isso, faça uma requisição POST para a rota /v1/carnet/:id/resend.

POST /v1/carnet/:id/resend

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

{
  "email": "[email protected]"
}

Respostas

As respostas abaixo representam Sucesso do consumo.

🟢 200

{
  "code": 200 // retorno HTTP "200" informando que o pedido foi bem sucedido
}

Reenvio de uma parcela específica de carnê por e-mail

É possível reenviar uma parcela específica de um carnê para um endereço de e-mail válido. Para isso, verifique que o carnet_id desejado esteja no status waiting (ou seja, "aguardando").

Se a parcela estiver aguardando, você pode fazer o reenvio enviando uma requisição POST para a rota /v1/carnet/:id/resend. Nessa requisição, você deve informar o número da parcela que deseja reenviar por e-mail (por exemplo: 3 - se for a terceira parcela que você deseja reenviar). Dessa forma, o sistema irá reenviar a parcela selecionada para o endereço de e-mail desejado.

POST /v1/carnet/:id/parcel/:parcel/resend

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

{
  "email": "[email protected]"
}

Respostas

As respostas abaixo representam Sucesso do consumo.

🟢 200

{
  "code": 200 // retorno HTTP "200" informando que o pedido foi bem sucedido
}

Acrescentar descrição ao histórico de uma transação

Assim como nas transações individuais, um carnê também possui um histórico que registra todas as ações que o carnê sofreu ao longo do tempo. Nesse histórico, é possível adicionar mensagens personalizadas, sem que elas afetem o fluxo do carnê.

Para adicionar uma mensagem personalizada ao histórico de um carnê, basta enviar uma requisição POST para a rota /v1/carnet/:id/history.

POST /v1/carnet/:id/history

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

{
  "description": "Camisa Polo tamanho G cor azul."
}

Respostas

As respostas abaixo representam Sucesso do consumo.

🟢 200

{
  "code": 200 // retorno HTTP "200" informando que o pedido foi bem sucedido
}

Marcar como pago (baixa manual) um determinado carnê

Por vezes, alguns clientes acabam efetuando o pagamento de cobranças de outras maneiras, como um pagamento em mãos ou um depósito bancário.

Na conta Efí, somente é possível confirmar manualmente as emissões que foram feitas por boletos ou carnês. As cobranças realizadas por meio de links de pagamento, mesmo que o pagamento seja realizado por boleto, não podem ser confirmadas manualmente.

Importante!

Em uma transação marcada como paga, nenhum valor de pagamento é retornado via API. Não serão aplicados automaticamente descontos, multas e moras.

Conheça as duas maneiras de confirmar manualmente o pagamento de uma cobrança na Efí:

1. Por meio do painel Efí:

• Faça login em sua conta Efí;
• Acesse o menu “Receber” e, logo em seguida, “Gestão de cobranças”;
• Selecione a opção “Carnês”;
• Escolha o carnê que deseja confirmar;
• Em seguida, clique no botão azul "Marcar como pago".

Esta operação não possui cobrança de tarifas.

Observação

Não é possível confirmar manualmente o pagamento de cobranças que foram canceladas.

2. Por meio de requisição via API:

Apenas transações com status waiting ou unpaid podem ser confirmadas manualmente. Existem dois endpoints responsáveis pelas confirmações manuais de pagamento:

• settleCharge: permite marcar como pago (baixa manual) uma determinada transação;
• settleCarnetParcel: permite marcar como pago (baixa manual) uma determinada parcela de um carnê.

NOTA

As confirmações de pagamento podem ser:

Confirmações Automáticas: é o mecanismo padrão oferecido pela API por meio da URL de notificação. Ou seja, disparamos um POST para sua URL de notificação assim que houver uma mudança no status da transação, seu sistema recepciona essa informação e realiza as tratativas para as quais foi designado. Em outras palavras, o status paid estará contido na notificação que enviamos. Neste caso, o status da transação será paid.

Confirmações Manuais: representada pelos endpoints settleCharge e settleCarnetParcel. É quando o pagamento foi realizado por formas de pagamento alternativas (ex: pagamento em mãos) e o integrador efetuou a confirmação manual pelo painel Efí, via requisição à API ou pelo seu próprio sistema de gestão. Neste caso, o status da transação será settled.

Para marcar uma transação como paga (baixa manual), você deve enviar uma requisição PUT para a rota /v1/carnet/:id/settle.

Atenção!

Transações marcadas como paga não geram movimentações financeiras em uma conta Efí. Isso ocorre porque o controle financeiro não é realizado pela Efí.

PUT /v1/carnet/:id/settle

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

Parâmetro de entrada: informe a "carnet_id" da transação desejada

Respostas

As respostas abaixo representam Sucesso(200) do consumo.

🟢 200

{
  "code": 200 // retorno HTTP "200" informando que o pedido foi bem sucedido
}

Marcar como pago determinada parcela de carnê

Para marcar manualmente uma parcela de um carnê como paga, você deve fornecer o ID do carnê (carnet_id) e o número da parcela do carnê que deseja marcar como pago.

Por exemplo, se você tem um carnê com 12 parcelas, e deseja marcar a segunda parcela como paga, você deve enviar uma requisição PUT para a rota /v1/carnet/:id/parcel/:parcel/settle, onde :id é o ID do carnê (por exemplo, 24744) e :parcel é o número da parcela (por exemplo, 2).

Conheça as duas maneiras de confirmar manualmente o pagamento de uma cobrança na Efí:

1. Por meio do painel Efí:

• Faça login em sua conta Efí;
• Acesse o menu “Receber” e, logo em seguida, “Gestão de cobranças”;
• Selecione a opção “Carnês”;
• Escolha o carnê que deseja confirmar;
• Em seguida, clique no botão azul "Marcar como pago".

Esta operação não possui cobrança de tarifas.

Observação

Não é possível confirmar manualmente o pagamento de cobranças que foram canceladas.

2. Por meio de requisição via API:

Apenas transações com status waiting ou unpaid podem ser confirmadas manualmente. Existem dois endpoints responsáveis pelas confirmações manuais de pagamento:

• settleCarnetParcel: permite marcar como pago (baixa manual) uma determinada parcela de um carnê.

PUT /v1/carnet/:id/parcel/ :parcel/settle

Requer ativação da API de Emissão de cobranças em sua aplicação

Requisição

Dados de entrada

Parâmetro de entrada: informe o "carnet_id" e a "parcel" da transação desejada

Respostas

As respostas abaixo representam Sucesso(200) do consumo.

🟢 200

{
  "code": 200 // retorno HTTP "200" informando que o pedido foi bem sucedido
}