v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Capturar Fatura

Captura uma fatura com status "em análise" (in_analysis) através do seu ID. Para mais informações sobre cobrança em duas etapas

post/invoices/{id}/capture

Path parameters

idstring required

ID da Fatura

Response

200

idstring

due_datestring

currencystring

discount_centsinteger

emailstring

items_total_centsinteger

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:notification_url","oasType":"schema","type":"unknown"}

return_urlstring

statusstring

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:tax_cents","oasType":"schema","type":"unknown"}

total_centsinteger

total_paid_centsinteger

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:taxes_paid_cents","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:paid_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:paid_cents","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:cc_emails","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:financial_return_date","oasType":"schema","type":"unknown"}

payable_withstring

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:overpaid_cents","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:ignore_due_email","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:ignore_canceled_email","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:advance_fee_cents","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:commission_cents","oasType":"schema","type":"unknown"}

early_payment_discountboolean

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:order_id","oasType":"schema","type":"unknown"}

updated_atstring

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:credit_card_brand","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:credit_card_bin","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:credit_card_last_4","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:credit_card_captured_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:credit_card_tid","oasType":"schema","type":"unknown"}

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

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:max_installments_value","oasType":"schema","type":"unknown"}

payer_namestring

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:payer_email","oasType":"schema","type":"unknown"}

payer_cpf_cnpjstring

payer_phonestring

payer_phone_prefixstring

payer_address_zip_codestring

payer_address_streetstring

payer_address_districtstring

payer_address_citystring

payer_address_statestring

payer_address_numberstring

payer_address_complementstring

payer_address_countrystring

late_payment_fineinteger

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:late_payment_fine_cents","oasType":"schema","type":"unknown"}

split_idstring

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:external_payment_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:external_payment_description","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:payment_booklet_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:subscription_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:credit_card_transaction","oasType":"schema","type":"unknown"}

account_idstring

bank_account_branchstring

bank_account_numberstring

account_namestring

secure_idstring

secure_urlstring

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:customer_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:customer_ref","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:customer_name","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:user_id","oasType":"schema","type":"unknown"}

totalstring

taxes_paidstring

total_paidstring

total_overpaidstring

total_refundedstring

fine_centsinteger

commissionstring

fines_on_occurrence_daystring

total_on_occurrence_daystring

fines_on_occurrence_day_centsinteger

total_on_occurrence_day_centsinteger

refunded_centsinteger

remaining_captured_centsinteger

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:advance_fee","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:estimated_advance_fee","oasType":"schema","type":"unknown"}

paidstring

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:original_payment_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:double_payment_id","oasType":"schema","type":"unknown"}

per_day_interestboolean

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:per_day_interest_value","oasType":"schema","type":"unknown"}

per_day_interest_centsinteger

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:interest","oasType":"schema","type":"unknown"}

discountstring

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:duplicated_invoice_id","oasType":"schema","type":"unknown"}

bank_slip_extra_dueinteger

created_atstring

created_at_isostring

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:authorized_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:authorized_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:expired_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:expired_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:refunded_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:refunded_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:canceled_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:canceled_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:protested_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:protested_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:chargeback_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:chargeback_at_iso","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:occurrence_date","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:refundable","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:installments","oasType":"schema","type":"unknown"}

transaction_numberinteger

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:payment_method","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}/capture:post:responses:200:content:application/json:schema:properties:financial_return_dates","oasType":"schema","type":"unknown"}

early_payment_discountsobject[]

Example response

{
  "id": "EBB161AAB22849BFA047D5F1DF55AEE9",
  "due_date": "2025-04-02",
  "currency": "BRL",
  "discount_cents": 24,
  "email": "email@iugu.com",
  "items_total_cents": 400,
  "return_url": "https://google.com",
  "status": "paid",
  "total_cents": 376,
  "payable_with": "all",
  "updated_at": "2025-04-02T13:14:27-03:00",
  "payer_name": "John",
  "payer_cpf_cnpj": "11343675030",
  "payer_phone": "971113024",
  "payer_phone_prefix": "11",
  "payer_address_zip_code": "13056-344",
  "payer_address_street": "Rua Antônio Nunes",
  "payer_address_district": "Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)",
  "payer_address_city": "Campinas",
  "payer_address_state": "SP",
  "payer_address_number": "21",
  "payer_address_complement": "AP1702",
  "payer_address_country": "Brasil",
  "split_id": "3270D0BAB8074BDE98E382340338550C",
  "variables": [
    {
      "variable": "barcode_v1",
      "value": "40197103900000003762025092000000000000200864"
    }
  ],
  "custom_variables": [
    {
      "name": "Minha variável",
      "value": "DSAY312HKD312JH"
    }
  ],
  "logs": [
    {
      "id": "F34952A91D364C1AA2C827F62615239D",
      "description": "Email de Fatura enviado!",
      "notes": "Fatura enviada com sucesso para: email@iugu.com",
      "created_at": "02/04, 13:14"
    }
  ],
  "account_id": "44C5DC6376804D1FA792CBCA382105C1",
  "bank_account_branch": "0001",
  "bank_account_number": "2739435-0",
  "account_name": "Nome da Conta",
  "secure_id": "ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03",
  "secure_url": "https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03",
  "total": "R$ 3,76",
  "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",
  "discount": "R$ 0,24",
  "bank_slip_extra_due": 1,
  "created_at": "02/04, 13:14",
  "created_at_iso": "2025-04-02T13:14:26-03:00",
  "transaction_number": 412825250927504,
  "bank_slip": {
    "digitable_line": "40192025089200000000700002008647710390000000376",
    "barcode_data": "40197103900000003762025092000000000000200864",
    "barcode": "https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode",
    "bank_slip_url": "https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip",
    "bank_slip_pdf_url": "https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf",
    "bank_slip_bank": 401,
    "bank_slip_status": "pending",
    "recipient_cpf_cnpj": "42135294870"
  },
  "pix": {
    "qrcode": "https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03",
    "qrcode_text": "00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6",
    "status": "qr_code_created"
  },
  "items": [
    {
      "id": "03B951855B92410890A0EA5742636E96",
      "description": "Nome do Item",
      "price_cents": 300,
      "quantity": 1,
      "created_at": "2025-04-02T13:14:26-03:00",
      "updated_at": "2025-04-02T13:14:26-03:00",
      "price": "R$ 3,00"
    }
  ],
  "split_rules": [
    {
      "id": "AB1B22F356464105A3C17BA18A640BA9",
      "split_id": "3270D0BAB8074BDE98E382340338550C",
      "recipient_account_id": "E638DCED176240E4A510510C065FB52D",
      "cents": 10,
      "percent": 1,
      "permit_aggregated": true,
      "created_at": "2025-04-02T13:14:26-03:00",
      "updated_at": "2025-04-02T13:14:26-03:00"
    }
  ]
}