Considerar Fatura Paga Externamente

Possibilita a baixa de pagamento de uma fatura iugu que foi paga externamente e/ou por outros intermédios. Este processo altera o status pendente de uma fatura para "Paga Externamente".

put/invoices/{id}/externally_pay

Request

Base URL
https://api.iugu.com/v1
URL
https://api.iugu.com/v1/invoices/{id}/externally_pay
Auth
API key in query parameter api_token

Path parameters

idstring required

ID da fatura na iugu

Request body

external_payment_idstring required

ID externo da fatura (32 caracteres no máx.)

external_payment_descriptionstring

Descrição do pagamento (50 caracteres no máx.)

Response

200

idstring

due_datestring

currencystring

discount_centsinteger

emailstring

items_total_centsinteger

notification_urlunknown

return_urlstring

statusstring

tax_centsunknown

total_centsinteger

total_paid_centsinteger

taxes_paid_centsunknown

paid_atstring

paid_centsunknown

cc_emailsunknown

financial_return_dateunknown

payable_withstring

overpaid_centsunknown

ignore_due_emailunknown

ignore_canceled_emailunknown

advance_fee_centsunknown

commission_centsunknown

early_payment_discountboolean

order_idunknown

updated_atstring

credit_card_brandunknown

credit_card_binunknown

credit_card_last_4unknown

credit_card_captured_atunknown

credit_card_tidunknown

external_referenceunknown

max_installments_valueunknown

payer_namestring

payer_emailunknown

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

late_payment_fine_centsunknown

split_idstring

external_payment_idstring

external_payment_descriptionunknown

payment_booklet_idunknown

subscription_idunknown

credit_card_transactionunknown

account_idstring

bank_account_branchstring

bank_account_numberstring

account_namestring

secure_idstring

secure_urlstring

customer_idunknown

customer_refunknown

customer_nameunknown

user_idunknown

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

advance_feeunknown

estimated_advance_feeunknown

paidstring

original_payment_idunknown

double_payment_idunknown

per_day_interestboolean

per_day_interest_valueunknown

per_day_interest_centsinteger

interestunknown

discountstring

duplicated_invoice_idunknown

bank_slip_extra_dueinteger

created_atstring

created_at_isostring

authorized_atunknown

authorized_at_isounknown

expired_atunknown

expired_at_isounknown

refunded_atunknown

refunded_at_isounknown

canceled_atunknown

canceled_at_isounknown

protested_atunknown

protested_at_isounknown

chargeback_atunknown

chargeback_at_isounknown

occurrence_dateunknown

refundableunknown

installmentsunknown

transaction_numberinteger

payment_methodunknown

financial_return_datesunknown

bank_slipunknown

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": "externally_paid",
  "total_cents": 376,
  "paid_at": "2025-04-02T13:49:07-03:00",
  "payable_with": "all",
  "updated_at": "2025-04-02T13:49:07-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",
  "external_payment_id": "my_id",
  "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,
  "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"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.