v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Consultar um carnê

Consulta um carnê criado através do seu ID

get/payment_booklets/{id}

Path parameters

idstring required

Response

200

idstring

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

{"stackTrail":"paths:/payment_booklets/{id}:get:responses:200:content:application/json:schema:properties:custom_instruction","oasType":"schema","type":"unknown"}

descriptionstring

price_centsinteger

started_atstring

finish_atstring

statusstring

payment_booklet_installmentsinteger

secure_urlstring

Example response

{
  "id": "6F10E0ACB4F3471CAE1356093E3999BB",
  "description": "Descrição da Capa do Carnê",
  "price_cents": 1000,
  "started_at": "2025-04-02T00:00:00-03:00",
  "finish_at": "2025-05-02T00:00:00-03:00",
  "status": "pending",
  "invoices": [
    {
      "id": "8A0D8340338F47F781B6FDAA46B92FEE",
      "due_date": "2025-04-02",
      "currency": "BRL",
      "email": "jose_silva@teste.com",
      "items_total_cents": 500,
      "status": "pending",
      "total_cents": 500,
      "cc_emails": "jose_2@teste.com",
      "payable_with": "bank_slip",
      "updated_at": "2025-04-02T15:24:42-03:00",
      "payer_name": "José",
      "payer_email": "jose_silva@teste.com",
      "payer_cpf_cnpj": "11343675030",
      "payer_phone": "999999999",
      "payer_phone_prefix": "011",
      "payer_address_zip_code": "01310100",
      "payer_address_street": "Avenida Paulista",
      "payer_address_district": "Bela Vista",
      "payer_address_city": "São Paulo",
      "payer_address_state": "SP",
      "payer_address_number": "1048",
      "payer_address_complement": "55b",
      "payment_booklet_id": "6F10E0ACB4F3471CAE1356093E3999BB",
      "variables": [
        {
          "variable": "barcode_v1",
          "value": "40199103900000005002025092000000000000244677"
        }
      ],
      "logs": [
        {
          "id": "B391B09A20D14E629FD27C18E52A5EA3",
          "description": "Email de Fatura enviado!",
          "notes": "Fatura enviada com sucesso para: jose_silva@teste.com",
          "created_at": "02/04, 15:23"
        }
      ],
      "account_id": "27016E1AD888499A98994E781B6C3762",
      "bank_account_branch": "0001",
      "bank_account_number": "3693443-0",
      "account_name": "IUGU Teste Produto e Integrações",
      "secure_id": "8a0d8340-338f-47f7-81b6-fdaa46b92fee-da0e",
      "secure_url": "https://checkout.iugu.com/invoices/8a0d8340-338f-47f7-81b6-fdaa46b92fee-da0e",
      "customer_id": "796B9E7392444DAA971D3F1E0BE83F89",
      "customer_ref": "José",
      "customer_name": "José",
      "total": "R$ 5,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",
      "created_at": "02/04, 15:23",
      "created_at_iso": "2025-04-02T15:23:48-03:00",
      "transaction_number": 253625250927197,
      "bank_slip": {
        "digitable_line": "40192025089200000000700002446771910390000000500",
        "barcode_data": "40199103900000005002025092000000000000244677",
        "barcode": "https://api.iugu.com/v1/public/invoice/8a0d8340-338f-47f7-81b6-fdaa46b92fee-da0e/barcode",
        "bank_slip_url": "https://boletos.iugu.com/v1/public/invoice/8a0d8340-338f-47f7-81b6-fdaa46b92fee-da0e/bank_slip",
        "bank_slip_pdf_url": "https://boletos.iugu.com/v1/public/invoice/8a0d8340-338f-47f7-81b6-fdaa46b92fee-da0e/bank_slip.pdf",
        "bank_slip_bank": 401,
        "bank_slip_status": "registered",
        "recipient_cpf_cnpj": "15111975000164"
      },
      "items": [
        {
          "id": "AF667AAC3860426BAC7744E14E8E6052",
          "description": "Descrição da Capa do Carnê - parcela 1 de 2",
          "price_cents": 500,
          "quantity": 1,
          "created_at": "2025-04-02T15:23:48-03:00",
          "updated_at": "2025-04-02T15:23:48-03:00",
          "price": "R$ 5,00"
        }
      ]
    }
  ],
  "customer": {
    "id": "796B9E7392444DAA971D3F1E0BE83F89",
    "datasource_id": "EA29CC4EFA5B4150BCF2C13857246168",
    "email": "jose_silva@teste.com",
    "created_at": "2024-01-02T10:28:13-03:00",
    "updated_at": "2024-04-29T12:03:42-03:00",
    "name": "José",
    "cc_emails": "jose_2@teste.com",
    "cpf_cnpj": "113.436.750-30",
    "zip_code": "01310100",
    "number": "1048",
    "complement": "55b",
    "street": "Avenida Paulista",
    "district": "Bela Vista",
    "phone": "999999999",
    "phone_prefix": "011"
  },
  "payment_booklet_installments": 2,
  "secure_url": "https://faturas.iugu.com/payment_booklet/6f10e0ac-b4f3-471c-ae13-56093e3999bb-d989"
}