v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Buscar Fatura por IDs externos

Permite consultar uma Fatura através dos valores informados nos parâmetros external_referece, order_id ou end_to_end (PIX).

get/resource_search

Query parameters

query_fieldstring required

Tipo de ID que procura. Sendo external_id, order_id ou end_to_end.

valuestring required

Valor a ser procurado.

Response

200

referenceable_idstring

referenceable_typestring

Example response

{
  "referenceable_id": "AB1136DB52934C629DEE3CAC141C0C3E",
  "referenceable_type": "Invoice",
  "resource": {
    "id": "AB1136DB52934C629DEE3CAC141C0C3E",
    "due_date": "2025-02-18",
    "currency": "BRL",
    "email": "email@iug.com",
    "items_total_cents": 300,
    "status": "paid",
    "total_cents": 300,
    "total_paid_cents": 300,
    "taxes_paid_cents": 3,
    "paid_at": "2025-02-18T16:26:19-03:00",
    "paid_cents": 300,
    "payable_with": "pix",
    "updated_at": "2025-02-18T16:26:20-03:00",
    "variables": [
      {
        "variable": "payment_method",
        "value": "iugu_pix"
      }
    ],
    "logs": [
      {
        "id": "BE101B1EC8D647C7AEC59B9BEA947103",
        "description": "Email de Recibo enviado!",
        "notes": "Recibo enviado com sucesso para: email@iug.com",
        "created_at": "18/02, 16:26"
      }
    ],
    "account_id": "44C5DC6376804D1FA792CBCA382105C1",
    "bank_account_branch": "0001",
    "bank_account_number": "2739435-0",
    "account_name": "Nome da Conta",
    "secure_id": "ab1136db-5293-4c62-9dee-3cac141c0c3e-9329",
    "secure_url": "https://checkout.iugu.com/invoices/-5293-4c62-9dee-3cac141c0c3e-9329",
    "total": "R$ 3,00",
    "taxes_paid": "R$ 0,03",
    "total_paid": "R$ 3,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$ 3,00",
    "total_on_occurrence_day_cents": 300,
    "remaining_captured_cents": 300,
    "paid": "R$ 3,00",
    "bank_slip_extra_due": 10,
    "created_at": "18/02, 16:15",
    "created_at_iso": "2025-02-18T16:15:32-03:00",
    "occurrence_date": "2025-02-18",
    "refundable": true,
    "payment_method": "iugu_pix",
    "pix": {
      "qrcode": "https://faturas.iugu.com/qr_code/ab1136db-5293-4c62-9dee-3cac141c0c3e-9329",
      "qrcode_text": "00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/AB1136DB52934C629DEE3CAC141C0C3E52040000530398654043.005802BR5924NOME DA CONTA6009SAO PAULO62070503***6304EC4D",
      "status": "paid",
      "payer_cpf_cnpj": "11122233344",
      "payer_name": "Nome do Pagador",
      "end_to_end_id": "A12331202502181926Vc0JrA0RiSK",
      "account_number_last_digits": "5132"
    },
    "items": [
      {
        "id": "9A989E79E6094548B10E7A356A06E7DF",
        "description": "Item",
        "price_cents": 300,
        "quantity": 1,
        "created_at": "2025-02-18T16:15:32-03:00",
        "updated_at": "2025-02-18T16:15:32-03:00",
        "price": "R$ 3,00"
      }
    ]
  }
}