Realizar uma cobrança simples via boleto por API

📘

O que você irá aprender com esse artigo?

  • Configurar boleto bancário como método de pagamento de uma fatura
  • Realizar uma cobrança simples com boleto

Caso de uso

“Preciso que meu cliente consiga realizar o pagamento de um produto ou serviço por boleto bancário, num processo simples e com checkout transparente.”

Configuração do boleto bancário

Quando você precisa cobrar um cliente via boleto bancário, é necessário configurar essa funcionalidade dentro do painel. Para isso, acesse o ícone de Configurações > Boleto Bancário e então mantenha a opção do método com Ativo. Defina suas atribuições nos campos e clique em Salvar.

Após realizar essa configuração, será possível criar uma cobrança ou fatura avulsa com boleto via API.Após realizar essa configuração, será possível criar uma cobrança ou fatura avulsa com boleto via API.

Após realizar essa configuração, será possível criar uma cobrança ou fatura avulsa com boleto via API.

Cobrança simples com boleto

Realizar uma cobrança simples significa cobrar através de uma única requisição (request) informando os dados do cliente. Fazer isso é bem simples: basta realizar um POST na API Cobrança Direta.

Essa operação só pode ser feita com a inclusão de todos os dados de endereço do cliente: CEP, logradouro, número, complemento, etc.

Ao informar apenas o CEP na request, a iugu buscará pelo endereço (logradouro e número) com esse dado. Mas vale se atentar que alguns números de CEP não possuem informações detalhadas pelos Correios, especialmente cidades pequenas que possuem um único CEP para todo o município.

Quando é esse o caso, a emissão do boleto pode ser recusada pelo banco, gerando um erro. Por isso, é importante validar na sua aplicação se as informações de endereço do cliente estão corretas.

Modelo de request

curl --location --request POST 'https://api.iugu.com/v1/charge?api_token={chave_api} \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfruid=df598e45cd90947e522e12ec895a84f7059cacbc-1627922464' \
--data-raw '{
    "items": [
        {
            "description": "aaaa",
            "quantity": 1,
            "price_cents": 10000
        }
    ],
    "payer": {
        "address": {
            "street": "Conselheiro Lafayetti",
            "number": "155",
            "district": "São Paulo",
            "city": "São Caetano do Sul",
            "state": "SP",
            "zip_code": "09550-000",
            "complement": "AP 61"
        },
        "cpf_cnpj": "35914746830",
        "name": "iugu ",
        "phone": "11951701015"
    },
    "method":"bank_slip",
    "order_id": "order_id",
    "email": "[email protected]"
}'

Modelo de response

Note que o retorno obtido traz tanto o arquivo em PDF do boleto bancário, quanto a URL que direciona para a fatura iugu (com o boleto).

Se para seu modelo de negócio é necessário realizar o pro rata, descontos, multa e juros, indicamos que use a chamada de Criar Fatura, pois nela é possível emitir um boleto configurando esses detalhes.


Did this page help you?