v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Criar um carnê

Crie seus carnês através desta endpoint

post/payment_booklets

Request body

customer_idstring required

ID do cliente na iugu que você deseja criar o carnê

installmentsstring required

Quantidade de parcelas presentes no carnê. Deve ser escolhido entre 1-24 parcelas.

descriptionstring required

Descrição da Capa do Carnê

custom_instructionstring

Campo de instruções complementares ao carnê com limite de até 150 caracteres, incluindo caracteres especiais

started_atstring date

Data de início da cobrança do carnê. Se não enviado, o início será imediato. YYYY-MM-DD

invoice_finesboolean

Habilita multa por atraso de pagamento

invoice_fines_valuestring

Determine a % da multa a ser cobrada para pagamentos efetuados após a data de vencimento

invoice_per_day_interestboolean

Booleano que determina se cobra ou não juros por dia de atraso. Necessário passar a multa como true

invoice_per_day_interest_valuestring

Informar o valor percentual de juros por atraso que deseja cobrar

price_centsstring required

Valor total do carnê em centavos. Mínimo de 1$ real (100) por parcela.

invoice_payable_with_pixboolean

Envie 'true' para gerar o Carnê com o método PIX habilitado (QR code). Caso não envie este campo (ou envie 'false'), o carnê será gerado apenas com os boletos bancários.

invoice_early_payment_discountboolean

Ativa ou desativa os descontos por pagamento antecipado. Quando true, sobrepõe as configurações de desconto da conta.

external_referencestring

Referência externa do carnê

ignore_due_emailboolean

Se true, o cliente final não irá receber nenhum e-mail notificando a cobrança.

expires_instring

Expira uma fatura e impossibilita o seu pagamento depois 'x' dias após o vencimento. Valor enviado precisa estar entre 0 e 30. Se for enviado "0", a fatura ficará disponível para ser paga até às 23:59:59 do dia de vencimento.

Response

200

idstring

{"stackTrail":"paths:/payment_booklets:post:responses:200:content:application/json:schema:properties:external_reference","oasType":"schema","type":"unknown"}

custom_instructionstring

descriptionstring

price_centsinteger

started_atstring

finish_atstring

statusstring

payment_booklet_installmentsinteger

secure_urlstring

Example response

{
  "id": "48FCEF5D66754F09BD98678FC404EA8B",
  "custom_instruction": "difirhfiehjb jiiei uhdiehuiche ixhiwudhiuehd niwqiudhiwhuqe   jncieuhdq oijdi23214 543436 65654634 !@#$%&*(!@#$%?&*()",
  "description": "teste descrição",
  "price_cents": 23400,
  "started_at": "2024-02-09T00:00:00-03:00",
  "finish_at": "2024-04-09T00:00:00-03:00",
  "status": "pending",
  "invoices": [
    {
      "id": "20938197FC1A40D3BA73F675B9B7959E",
      "due_date": "2024-02-09",
      "currency": "BRL",
      "email": "novo_email@email.com",
      "items_total_cents": 7800,
      "status": "pending",
      "total_cents": 7800,
      "cc_emails": "email_2@email.com",
      "payable_with": [
        "bank_slip"
      ],
      "early_payment_discount": true,
      "updated_at": "2024-02-09T09:33:16-03:00",
      "payer_name": "novo nome",
      "payer_email": "novo_email@email.com",
      "payer_cpf_cnpj": "28489855005",
      "payer_phone": "988888888",
      "payer_phone_prefix": "011",
      "payer_address_zip_code": "01310-100",
      "payer_address_street": "Avenida Paulista",
      "payer_address_district": "Bela Vista",
      "payer_address_city": "São Paulo",
      "payer_address_state": "SP",
      "payer_address_number": "666",
      "payer_address_complement": "666A",
      "payment_booklet_id": "48FCEF5D66754F09BD98678FC404EA8B",
      "variables": [
        {
          "variable": "barcode_v1",
          "value": "40191962100000078002024040000000001000052356"
        }
      ],
      "logs": [
        {
          "id": "EB62831EFE574C6C9A244EB687F80029",
          "description": "Email de Fatura enviado!",
          "notes": "Fatura enviada com sucesso para: novo_email@email.com",
          "created_at": "09/02, 09:33"
        }
      ],
      "account_id": "27016E1AD888499A98994E781B6C3762",
      "bank_account_branch": "0001",
      "bank_account_number": "3693443-0",
      "account_name": "IUGU Teste Produto e Integrações",
      "secure_id": "20938197-fc1a-40d3-ba73-f675b9b7959e-8c06",
      "secure_url": "https://faturas.iugu.com/20938197-fc1a-40d3-ba73-f675b9b7959e-8c06",
      "customer_id": "11ACC17CF1BD4805B491C5739C95F374",
      "customer_ref": "novo nome",
      "customer_name": "novo nome",
      "total": "R$ 78,00",
      "taxes_paid": "R$ 0,00",
      "total_paid": "R$ 0,00",
      "total_overpaid": "R$ 0,00",
      "total_refunded": "R$ 0,00",
      "commission": "R$ 0,00",
      "fines_on_occurrence_day": "R$ 0,00",
      "total_on_occurrence_day": "R$ 0,00",
      "paid": "R$ 0,00",
      "bank_slip_extra_due": 2,
      "created_at": "09/02, 09:33",
      "created_at_iso": "2024-02-09T09:33:16-03:00",
      "transaction_number": 89204751,
      "bank_slip": {
        "digitable_line": "40192024094000000000610000523562196210000007800",
        "barcode_data": "40191962100000078002024040000000001000052356",
        "barcode": "https://api.iugu.com/v1/public/invoice/20938197-fc1a-40d3-ba73-f675b9b7959e-8c06/barcode",
        "bank_slip_bank": 401,
        "bank_slip_status": "pending",
        "recipient_cpf_cnpj": "15111975000164"
      },
      "pix": {
        "qrcode": "https://faturas.iugu.com/qr_code/20938197-fc1a-40d3-ba73-f675b9b7959e-8c06",
        "qrcode_text": "00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/20938197FC1A40D3BA73F675B9B7959E520400005303986540578.005802BR5925IUGU INSTITUICAO DE PAGAM6009SAO PAULO62070503***63043AB1",
        "status": "qr_code_created"
      },
      "items": [
        {
          "id": "BDA2395ECFDB45D1885DBB22C4A79EDB",
          "description": "teste descrição - parcela 1 de 3",
          "price_cents": 7800,
          "quantity": 1,
          "created_at": "2024-02-09T09:33:16-03:00",
          "updated_at": "2024-02-09T09:33:16-03:00",
          "price": "R$ 78,00"
        }
      ]
    }
  ],
  "customer": {
    "id": "11ACC17CF1BD4805B491C5739C95F374",
    "datasource_id": "EA29CC4EFA5B4150BCF2C13857246168",
    "email": "novo_email@email.com",
    "created_at": "2023-11-06T10:57:43-03:00",
    "updated_at": "2024-01-02T10:33:36-03:00",
    "name": "novo nome",
    "cc_emails": "email_2@email.com",
    "cpf_cnpj": "28489855005",
    "zip_code": "01310-100",
    "number": "666",
    "complement": "666A",
    "street": "Avenida Paulista",
    "district": "Bela Vista",
    "phone": "988888888",
    "phone_prefix": "011"
  },
  "payment_booklet_installments": 3,
  "secure_url": "https://faturas.iugu.com/payment_booklet/48fcef5d-6675-4f09-bd98-678fc404ea8b-7f4e"
}