openapi: 3.2.0 info: title: Iugu Invoices API version: '1.0' description: 'Operations tagged Invoices across 2 of this provider''s published API definitions: iugu-faturas-openapi.yml, iugu-tokens-e-cobran-a-direta-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.iugu.com/v1 security: - sec0: [] tags: - name: Invoices paths: /invoices: post: summary: Criar Fatura description: Cria uma fatura para um cliente. Para mais informações sobre fatura operationId: criar-fatura requestBody: content: application/json: schema: type: object required: - email - due_date - items properties: email: type: string description: E-mail do cliente cc_emails: type: string description: Endereços de E-mail para cópia separados por vírgula. default: email1@iugu.com,email2@iugu.com due_date: type: string description: 'Data do vencimento. (Formato: ''AAAA-MM-DD'').' format: date ensure_workday_due_date: type: boolean description: Se `true`, garante que a data de vencimento seja apenas em dias de semana, e não em sábados ou domingos. default: false expires_in: type: string description: Define em quantos dias após o vencimento a fatura expira e deixa de poder ser paga. O valor deve estar entre "*0*" e "*120*" por padrão. Se informado "*0*", a fatura poderá ser paga até 23:59:59 do dia de vencimento.
bank_slip_extra_due: type: string description: Prazo máximo para pagamento do boleto após o vencimento. O prazo máximo para pagamento deve ser entre *"1"* e *"120"* dias após a data de vencimento. items: type: array description: Itens da fatura. O parâmetro `price_cents` tem o **valor mínimo de 100**. Limite de **30 itens** em `test_mode`. Já `live_mode` **não há limites**. items: properties: description: type: string description: Descrição do item quantity: type: integer description: Quantidade do item format: int32 price_cents: type: integer description: Preço do item em centavos. Valor mínimo 100. format: int32 type: object payable_with: type: array description: 'Método de pagamento que será disponibilizado para esta Fatura (`all`, `credit_card`, `bank_slip` ou `pix`). Obs: Caso esta Fatura esteja atrelada à uma Assinatura, a prioridade é herdar o valor atribuído na Assinatura; caso esta esteja atribuído o valor ''all'', o sistema considerará o ''payable_with'' da Fatura; se não, o sistema considerará o ''payable_with'' da Assinatura.' items: type: string payer: properties: cpf_cnpj: type: string description: CPF ou CNPJ do pagador. Aceito o campo alfanumérico apenas para CNPJ. name: type: string description: Nome do pagador. **Obrigatório** se `cpf_cnpj` for informado. **Máximo 140 caracteres**. email: type: string description: E-mail do pagador phone_prefix: type: string description: DDD do número de telefone do pagador phone: type: string description: Número de telefone do pagador address: type: object description: 'Endereço do cliente, conforme os parâmetros seguintes:' properties: zip_code: type: string description: CEP street: type: string description: Rua number: type: string description: Número district: type: string description: Bairro city: type: string description: Cidade state: type: string description: 'Estado (Ex: SP)' country: type: string description: País complement: type: string description: Complemento required: [] type: object description: Informações do Cliente para o Anti Fraude ou Boleto. Dados são obrigatórios para emissão de boletos e Pix. splits: type: array description: Lista de splits a serém aplicado nas faturas pagas. [Para mais informações sobre com funciona o split por fatura](https://dev.iugu.com/docs/split-por-fatura-no-cart%C3%A3o-de-cr%C3%A9dito-por-api) items: properties: recipient_account_id: type: string description: ID Da conta que irá receber o split cents: type: integer description: Centavos a serem cobrados da fatura format: int32 percent: type: number description: Porcentagem a ser cobrada da fatura format: float bank_slip_cents: type: integer description: Valor em centavos a ser cobrado apenas em transações no boleto. format: int32 bank_slip_percent: type: number description: Valor em porcentagem a ser cobrado apenas em transações no boleto. format: float credit_card_cents: type: integer description: Valor em centavos a ser cobrado apenas em transações no cartão de crédito. format: int32 credit_card_percent: type: number description: Valor em porcentagem a ser cobrado apenas em transações no cartão de crédito. format: float pix_cents: type: integer description: Valor em centavos a ser cobrado apenas em transações no pix. format: int32 pix_percent: type: number description: Valor em porcentagem a ser cobrado apenas em transações no pix. format: float permit_aggregated: type: boolean description: Permite agregar comissionamento percentual + fixo. credit_card_1x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 1x no cartão de crédito. credit_card_2x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 2x no cartão de crédito. credit_card_3x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 3x no cartão de crédito. credit_card_4x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 4x no cartão de crédito. credit_card_5x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 5x no cartão de crédito. credit_card_6x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 6x no cartão de crédito. credit_card_7x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 7x no cartão de crédito. credit_card_8x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 8x no cartão de crédito. credit_card_9x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 9x no cartão de crédito. credit_card_10x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 10x no cartão de crédito. credit_card_11x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 11x no cartão de crédito. credit_card_12x_cents: type: string description: Valor em centavos a ser cobrado apenas em transações em 12x no cartão de crédito. credit_card_1x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 1x no cartão de crédito. credit_card_2x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 2x no cartão de crédito. credit_card_3x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 3x no cartão de crédito. credit_card_4x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 4x no cartão de crédito. credit_card_5x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 5x no cartão de crédito. credit_card_6x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 6x no cartão de crédito. credit_card_7x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 7x no cartão de crédito. credit_card_8x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 8x no cartão de crédito. credit_card_9x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 9x no cartão de crédito. credit_card_10x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 10x no cartão de crédito. credit_card_11x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 11x no cartão de crédito. credit_card_12x_percent: type: string description: Valor em porcentagem a ser cobrado apenas em transações em 12x no cartão de crédito. type: object customer_id: type: string description: ID do Cliente subscription_id: type: string description: Amarra esta Fatura com a Assinatura especificada. Caso ocorra o pagamento desta fatura, a ciclagem da assinatura acontecerá normalmente. return_url: type: string description: Cliente é redirecionado para essa URL após efetuar o pagamento da Fatura pela página de Fatura da Iugu expired_url: type: string description: Cliente é redirecionado para essa URL se a Fatura que estiver acessando estiver expirada notification_url: type: string description: URL chamada para todas as notificações de Fatura, assim como os webhooks (Gatilhos) são chamados ignore_canceled_email: type: boolean description: Desliga o e-mail de cancelamento de fatura fines: type: boolean description: Booleano para Habilitar ou Desabilitar multa por atraso de pagamento late_payment_fine: type: integer description: Determine a multa % a ser cobrada para pagamentos efetuados após a data de vencimento format: int32 late_payment_fine_cents: type: integer description: Determine a multa por valor fixo a ser cobrada para pagamentos efetuados após a data de vencimento format: int32 per_day_interest: type: boolean description: Booleano que determina se cobra ou não juros por dia de atraso. 1% ao mês pro rata. Necessário passar a multa como true per_day_interest_value: type: integer description: Informar o valor percentual de juros que deseja cobrar. Não se aplica quando os valores diários de mora calculados são menores que 1 centavo. format: int32 per_day_interest_cents: type: integer description: Juros a ser cobrado por dia em centavos. Sobrepõem o per_day_interest_value. O juros somado em 30 dias deve ser inferior a 50% do valor da fatura. format: int32 discount_cents: type: integer description: Valor dos Descontos em centavos format: int32 ignore_due_email: type: boolean description: Booleano que ignora o envio do e-mail de cobrança credits: type: integer description: Caso tenha o 'subscription_id', pode-se enviar o número de créditos a adicionar nessa Assinatura baseada em créditos, quando a Fatura for paga. format: int32 custom_variables: type: array description: Variáveis Personalizadas items: properties: name: type: string description: Nome da Variável. **Limitado à 50 caracteres**. value: type: string description: Valor da Variável. **Limitado à 200 caracteres**. type: object early_payment_discount: type: boolean description: Ativa ou desativa os descontos por pagamento antecipado. Quando `true`, sobrepõe as configurações de desconto da conta. early_payment_discounts: type: array description: Quantidade de dias de antecedência para o pagamento receber o desconto (Se enviado, substituirá a configuração atual da conta) items: properties: days: type: integer description: Número de dias antes do vencimento para aplicação do desconto. format: int32 percent: type: number description: Valor do desconto em porcentagem. Não pode ser usado com `value_cents`. format: float value_cents: type: integer description: Valor do desconto em centavos. Não pode ser usado com `percent`. format: int32 type: object order_id: type: string description: Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura. external_reference: type: string description: Informação de referência externa, possibilitando a realização de pesquisa. Limite de 60 caracteres. max_installments_value: type: integer description: Limita quantidade máxima de parcelas. Caso não seja enviado, pegará o padrão configurado na conta. format: int32 soft_descriptor_light: type: string description: Altera a descrição da cobrança no cartão de crédito do cliente final (Até 12 caracteres). Caso não seja enviado, será utilizada a descrição configurada na conta. automatic_pix: type: object properties: journey: type: integer description: "Tipo de jornada: `3` ou `4`.
\n- Jornada 3: QRCode com primeiro pagamento - Cria recorrência junto com a primeira cobrança imediata.
\n- Jornada 4: QRCode de pagamento com proposta de criar recorrência para cobranças imediatas ou futuras." frequency: type: string description: Frequência da recorrência.
**Exemplo:** `weekly`, `monthly`, `quarterly`, `semiannual`, `annual`.
recurrence_beginning: type: string format: date description: 'Data de início da recorrência. Deve ser uma data futura (Formato: ''AAAA-MM-DD'').' contract_number: type: string description: Identificador do contrato. **Máximo de 35 caracteres.** end_date: type: string format: date description: 'Data de término da recorrência (Formato: ''AAAA-MM-DD'').' receiver_recurrence_id: type: string description: Solicita agendamento de um novo pagamento em uma recorrência já existente e autorizada pelo pagador. retry_policy: type: string description: Política de retentativas. Nesse mesmo parâmetro, pode-se informar **"retry_allowed"**; por padrão, considera-se **"retry_not_allowed"**. description: '**Dados do Payer são obrigatórios para emissão do Pix Automático.**
' required: - journey - frequency - recurrence_beginning - contract_number pix_qr_code_expires_at: type: string description: Data, hora, minuto e segundo que o QRCode irá expirar. Formato ISO 8601 — AAAA-MM-DDTHH:MM:SS-00:00 format: date-time pix_remittance_info: type: string description: 140 caracteres. Informações do Remetente. A exibição da informação dependerá do app do Banco. pix_additional_info: type: array description: Máximo 5 itens. A exibição da informação dependerá do app do Banco. items: properties: name: type: string description: Nome da Variável. **Limitado à 50 caracteres**. value: type: string description: Valor da Variável. **Limitado à 200 caracteres**. type: object password: type: string description: Senha para o cliente final abrir a fatura. RAW_BODY: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"EBB161AAB22849BFA047D5F1DF55AEE9\",\n \"due_date\": \"2025-04-02\",\n \"currency\": \"BRL\",\n \"discount_cents\": 24,\n \"email\": \"email@iugu.com\",\n \"items_total_cents\": 400,\n \"notification_url\": null,\n \"return_url\": \"https://google.com\",\n \"status\": \"pending\",\n \"tax_cents\": null,\n \"total_cents\": 376,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"financial_return_date\": null,\n \"payable_with\": \"all\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-04-02T13:14:27-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": \"John\",\n \"payer_email\": null,\n \"payer_cpf_cnpj\": \"11343675030\",\n \"payer_phone\": \"971113024\",\n \"payer_phone_prefix\": \"11\",\n \"payer_address_zip_code\": \"13056-344\",\n \"payer_address_street\": \"Rua Antônio Nunes\",\n \"payer_address_district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"payer_address_city\": \"Campinas\",\n \"payer_address_state\": \"SP\",\n \"payer_address_number\": \"21\",\n \"payer_address_complement\": \"AP1702\",\n \"payer_address_country\": \"Brasil\",\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"barcode_v1\",\n \"value\": \"40197103900000003762025092000000000000200864\"\n },\n {\n \"variable\": \"barcode_version\",\n \"value\": \"1\"\n },\n {\n \"variable\": \"payer.address.city\",\n \"value\": \"Campinas\"\n },\n {\n \"variable\": \"payer.address.complement\",\n \"value\": \"AP1702\"\n },\n {\n \"variable\": \"payer.address.country\",\n \"value\": \"Brasil\"\n },\n {\n \"variable\": \"payer.address.district\",\n \"value\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\"\n },\n {\n \"variable\": \"payer.address.number\",\n \"value\": \"21\"\n },\n {\n \"variable\": \"payer.address.state\",\n \"value\": \"SP\"\n },\n {\n \"variable\": \"payer.address.street\",\n \"value\": \"Rua Antônio Nunes\"\n },\n {\n \"variable\": \"payer.address.zip_code\",\n \"value\": \"13056-344\"\n },\n {\n \"variable\": \"payer.cpf_cnpj\",\n \"value\": \"11343675030\"\n },\n {\n \"variable\": \"payer.name\",\n \"value\": \"John\"\n },\n {\n \"variable\": \"payer.phone\",\n \"value\": \"971113024\"\n },\n {\n \"variable\": \"payer.phone_prefix\",\n \"value\": \"11\"\n },\n {\n \"variable\": \"payment_data.transaction_number\",\n \"value\": \"412825250927504\"\n }\n ],\n \"custom_variables\": [\n {\n \"name\": \"Minha variável\",\n \"value\": \"DSAY312HKD312JH\"\n }\n ],\n \"logs\": [\n {\n \"id\": \"F34952A91D364C1AA2C827F62615239D\",\n \"description\": \"Email de Fatura enviado!\",\n \"notes\": \"Fatura enviada com sucesso para: email@iugu.com\",\n \"created_at\": \"02/04, 13:14\"\n },\n {\n \"id\": \"63BD254B355D49F2850667053497DEB5\",\n \"description\": \"Fatura criada com sucesso!\",\n \"notes\": \"Fatura criada!\",\n \"created_at\": \"02/04, 13:14\"\n }\n ],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": \"0001\",\n \"bank_account_number\": \"2739435-0\",\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 3,76\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": \"R$ 0,24\",\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 1,\n \"created_at\": \"02/04, 13:14\",\n \"created_at_iso\": \"2025-04-02T13:14:26-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": 412825250927504,\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": {\n \"digitable_line\": \"40192025089200000000700002008647710390000000376\",\n \"barcode_data\": \"40197103900000003762025092000000000000200864\",\n \"barcode\": \"https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode\",\n \"bank_slip_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip\",\n \"bank_slip_pdf_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf\",\n \"bank_slip_bank\": 401,\n \"bank_slip_status\": \"pending\",\n \"bank_slip_error_code\": null,\n \"bank_slip_error_message\": null,\n \"recipient_cpf_cnpj\": \"42135294870\"\n },\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"qrcode_text\": \"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"03B951855B92410890A0EA5742636E96\",\n \"description\": \"Nome do Item\",\n \"price_cents\": 300,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 3,00\"\n },\n {\n \"id\": \"36E1C5DFFD834DB6A06B67DA76363C51\",\n \"description\": \"Nome do Item 2\",\n \"price_cents\": 100,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 1,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": [\n {\n \"id\": \"AB1B22F356464105A3C17BA18A640BA9\",\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"recipient_account_id\": \"E638DCED176240E4A510510C065FB52D\",\n \"cents\": 10,\n \"percent\": 1,\n \"credit_card_cents\": null,\n \"credit_card_percent\": null,\n \"bank_slip_cents\": null,\n \"bank_slip_percent\": null,\n \"pix_cents\": null,\n \"pix_percent\": null,\n \"permit_aggregated\": true,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"credit_card_1x_cents\": null,\n \"credit_card_2x_cents\": null,\n \"credit_card_3x_cents\": null,\n \"credit_card_4x_cents\": null,\n \"credit_card_5x_cents\": null,\n \"credit_card_6x_cents\": null,\n \"credit_card_7x_cents\": null,\n \"credit_card_8x_cents\": null,\n \"credit_card_9x_cents\": null,\n \"credit_card_10x_cents\": null,\n \"credit_card_11x_cents\": null,\n \"credit_card_12x_cents\": null,\n \"credit_card_1x_percent\": null,\n \"credit_card_2x_percent\": null,\n \"credit_card_3x_percent\": null,\n \"credit_card_4x_percent\": null,\n \"credit_card_5x_percent\": null,\n \"credit_card_6x_percent\": null,\n \"credit_card_7x_percent\": null,\n \"credit_card_8x_percent\": null,\n \"credit_card_9x_percent\": null,\n \"credit_card_10x_percent\": null,\n \"credit_card_11x_percent\": null,\n \"credit_card_12x_percent\": null,\n \"credit_card_13x_cents\": null,\n \"credit_card_14x_cents\": null,\n \"credit_card_15x_cents\": null,\n \"credit_card_16x_cents\": null,\n \"credit_card_17x_cents\": null,\n \"credit_card_18x_cents\": null,\n \"credit_card_13x_percent\": null,\n \"credit_card_14x_percent\": null,\n \"credit_card_15x_percent\": null,\n \"credit_card_16x_percent\": null,\n \"credit_card_17x_percent\": null,\n \"credit_card_18x_percent\": null\n }\n ]\n}" schema: type: object properties: id: type: string example: EBB161AAB22849BFA047D5F1DF55AEE9 due_date: type: string example: '2025-04-02' currency: type: string example: BRL discount_cents: type: integer example: 24 default: 0 email: type: string example: email@iugu.com items_total_cents: type: integer example: 400 default: 0 notification_url: {} return_url: type: string example: https://google.com status: type: string example: pending tax_cents: {} total_cents: type: integer example: 376 default: 0 total_paid_cents: type: integer example: 0 default: 0 taxes_paid_cents: {} paid_at: {} paid_cents: {} cc_emails: {} financial_return_date: {} payable_with: type: string example: all overpaid_cents: {} ignore_due_email: {} ignore_canceled_email: {} advance_fee_cents: {} commission_cents: {} early_payment_discount: type: boolean example: false default: true order_id: {} updated_at: type: string example: '2025-04-02T13:14:27-03:00' credit_card_brand: {} credit_card_bin: {} credit_card_last_4: {} credit_card_captured_at: {} credit_card_tid: {} external_reference: {} max_installments_value: {} payer_name: type: string example: John payer_email: {} payer_cpf_cnpj: type: string example: '11343675030' payer_phone: type: string example: '971113024' payer_phone_prefix: type: string example: '11' payer_address_zip_code: type: string example: 13056-344 payer_address_street: type: string example: Rua Antônio Nunes payer_address_district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) payer_address_city: type: string example: Campinas payer_address_state: type: string example: SP payer_address_number: type: string example: '21' payer_address_complement: type: string example: AP1702 payer_address_country: type: string example: Brasil late_payment_fine: type: integer example: 0 default: 0 late_payment_fine_cents: {} split_id: type: string example: 3270D0BAB8074BDE98E382340338550C external_payment_id: {} external_payment_description: {} payment_booklet_id: {} subscription_id: {} variables: type: array items: type: object properties: variable: type: string example: barcode_v1 value: type: string example: '40197103900000003762025092000000000000200864' custom_variables: type: array items: type: object properties: name: type: string example: Minha variável value: type: string example: DSAY312HKD312JH logs: type: array items: type: object properties: id: type: string example: F34952A91D364C1AA2C827F62615239D description: type: string example: Email de Fatura enviado! notes: type: string example: 'Fatura enviada com sucesso para: email@iugu.com' created_at: type: string example: 02/04, 13:14 credit_card_transaction: {} account_id: type: string example: 44C5DC6376804D1FA792CBCA382105C1 bank_account_branch: type: string example: '0001' bank_account_number: type: string example: 2739435-0 account_name: type: string example: Nome da Conta secure_id: type: string example: ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 secure_url: type: string example: https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 customer_id: {} customer_ref: {} customer_name: {} user_id: {} total: type: string example: R$ 3,76 taxes_paid: type: string example: R$ 0,00 total_paid: type: string example: R$ 0,00 total_overpaid: type: string example: R$ 0,00 total_refunded: type: string example: R$ 0,00 fine_cents: type: integer example: 0 default: 0 commission: type: string example: R$ 0,00 fines_on_occurrence_day: type: string example: R$ 0,00 total_on_occurrence_day: type: string example: R$ 0,00 fines_on_occurrence_day_cents: type: integer example: 0 default: 0 total_on_occurrence_day_cents: type: integer example: 0 default: 0 refunded_cents: type: integer example: 0 default: 0 remaining_captured_cents: type: integer example: 0 default: 0 advance_fee: {} estimated_advance_fee: {} paid: type: string example: R$ 0,00 original_payment_id: {} double_payment_id: {} per_day_interest: type: boolean example: false default: true per_day_interest_value: {} per_day_interest_cents: type: integer example: 0 default: 0 interest: {} discount: type: string example: R$ 0,24 duplicated_invoice_id: {} bank_slip_extra_due: type: integer example: 1 default: 0 created_at: type: string example: 02/04, 13:14 created_at_iso: type: string example: '2025-04-02T13:14:26-03:00' authorized_at: {} authorized_at_iso: {} expired_at: {} expired_at_iso: {} refunded_at: {} refunded_at_iso: {} canceled_at: {} canceled_at_iso: {} protested_at: {} protested_at_iso: {} chargeback_at: {} chargeback_at_iso: {} occurrence_date: {} refundable: {} installments: {} transaction_number: type: integer example: 412825250927504 default: 0 payment_method: {} financial_return_dates: {} bank_slip: type: object properties: digitable_line: type: string example: '40192025089200000000700002008647710390000000376' barcode_data: type: string example: '40197103900000003762025092000000000000200864' barcode: type: string example: https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode bank_slip_url: type: string example: https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip bank_slip_pdf_url: type: string example: https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf bank_slip_bank: type: integer example: 401 default: 0 bank_slip_status: type: string example: pending bank_slip_error_code: {} bank_slip_error_message: {} recipient_cpf_cnpj: type: string example: '42135294870' pix: type: object properties: qrcode: type: string example: https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 qrcode_text: type: string example: 00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6 status: type: string example: qr_code_created payer_cpf_cnpj: {} payer_name: {} end_to_end_id: {} end_to_end_refund_id: {} account_number_last_digits: {} items: type: array items: type: object properties: id: type: string example: 03B951855B92410890A0EA5742636E96 description: type: string example: Nome do Item price_cents: type: integer example: 300 default: 0 quantity: type: integer example: 1 default: 0 created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' price: type: string example: R$ 3,00 early_payment_discounts: type: array items: type: object properties: {} split_rules: type: array items: type: object properties: id: type: string example: AB1B22F356464105A3C17BA18A640BA9 split_id: type: string example: 3270D0BAB8074BDE98E382340338550C recipient_account_id: type: string example: E638DCED176240E4A510510C065FB52D cents: type: integer example: 10 default: 0 percent: type: integer example: 1 default: 0 credit_card_cents: {} credit_card_percent: {} bank_slip_cents: {} bank_slip_percent: {} pix_cents: {} pix_percent: {} permit_aggregated: type: boolean example: true default: true created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' credit_card_1x_cents: {} credit_card_2x_cents: {} credit_card_3x_cents: {} credit_card_4x_cents: {} credit_card_5x_cents: {} credit_card_6x_cents: {} credit_card_7x_cents: {} credit_card_8x_cents: {} credit_card_9x_cents: {} credit_card_10x_cents: {} credit_card_11x_cents: {} credit_card_12x_cents: {} credit_card_1x_percent: {} credit_card_2x_percent: {} credit_card_3x_percent: {} credit_card_4x_percent: {} credit_card_5x_percent: {} credit_card_6x_percent: {} credit_card_7x_percent: {} credit_card_8x_percent: {} credit_card_9x_percent: {} credit_card_10x_percent: {} credit_card_11x_percent: {} credit_card_12x_percent: {} credit_card_13x_cents: {} credit_card_14x_cents: {} credit_card_15x_cents: {} credit_card_16x_cents: {} credit_card_17x_cents: {} credit_card_18x_cents: {} credit_card_13x_percent: {} credit_card_14x_percent: {} credit_card_15x_percent: {} credit_card_16x_percent: {} credit_card_17x_percent: {} credit_card_18x_percent: {} '400': description: '400' content: application/json: examples: Result: value: "{\n \"errors\": [\n \"items deveria ser um Array\"\n ]\n}" schema: type: object properties: errors: type: array items: type: string example: items deveria ser um Array '422': description: '422' content: application/json: examples: Un.Entity: value: "{\n \"errors\": {\n \"due_date\": [\n \"não pode ficar em branco\",\n \"não pode estar mais que três anos a frente\",\n \"não pode estar no passado\"\n ]\n }\n}" schema: type: object properties: errors: type: object properties: due_date: type: array items: type: string example: não pode ficar em branco x-internal: false tags: - Invoices get: summary: Listar/Buscar Faturas description: Retorna uma lista das faturas em sua conta ordenadas pela data de criação, da mais à menos recente. Por padrão, este endpoint retorna no máximo 100 registros. O campo "totalItems" contém sempre a quantidade total de faturas cadastradas, independentemente dos parâmetros de pesquisa utilizados, e o resultado da pesquisa fica sempre dentro de "items". operationId: listar-faturas parameters: - name: limit in: query description: Limita o número de registros retornados em até 100, que é o padrão de retorno desta chamada. Também utilizado em paginação. schema: type: integer format: int32 default: '' - name: start in: query description: Quantos registros pular do início da pesquisa, usado para paginação. schema: type: integer format: int32 - name: created_at_from in: query description: Registros criados a partir dessa data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00) schema: type: string format: date-time - name: created_at_to in: query description: Registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00) schema: type: string format: date-time - name: paid_at_from in: query description: Registros pagos a partir dessa data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00) schema: type: string format: date-time - name: paid_at_to in: query description: Registros pagos até esta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00) schema: type: string format: date - name: due_date in: query description: Data de Vencimento (AAAA-MM-DD) schema: type: string format: date - name: query in: query description: Neste parâmetro pode ser passado um texto para pesquisa como e-mail, nome, anotações e o order_id. Necessário usar a paginação (limit, start, etc) schema: type: string - name: updated_since in: query description: Registros atualizados desde o momento passado no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00) schema: type: string format: date-time - name: customer_id in: query description: ID do Cliente schema: type: string - name: status_filter in: query description: Usado para filtrar as faturas pelo status (pending, paid, canceled, partially_paid, externally_paid, refunded, expired, authorized) schema: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"items\": [\n {\n \"id\": \"ACD03D71D16249BAB49FC89EB6F8516F\",\n \"due_date\": \"2025-04-07\",\n \"currency\": \"BRL\",\n \"discount_cents\": null,\n \"email\": \"email@iugu.com\",\n \"notification_url\": null,\n \"return_url\": null,\n \"status\": \"pending\",\n \"tax_cents\": null,\n \"total_cents\": 500,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"payable_with\": \"credit_card\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-04-02T13:27:43-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": null,\n \"payer_email\": null,\n \"payer_cpf_cnpj\": null,\n \"payer_phone\": null,\n \"payer_phone_prefix\": null,\n \"payer_address_zip_code\": null,\n \"payer_address_street\": null,\n \"payer_address_district\": null,\n \"payer_address_city\": null,\n \"payer_address_state\": null,\n \"payer_address_number\": null,\n \"payer_address_complement\": null,\n \"payer_address_country\": null,\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": null,\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [],\n \"custom_variables\": [],\n \"logs\": [],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": null,\n \"bank_account_number\": null,\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"acd03d71-d162-49ba-b49f-c89eb6f8516f-5fa4\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/acd03d71-d162-49ba-b49f-c89eb6f8516f-5fa4\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 5,00\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"financial_return_date\": null,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": null,\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 10,\n \"created_at\": \"02/04, 13:27\",\n \"created_at_iso\": \"2025-04-02T13:27:43-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": null,\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": null,\n \"pix\": {\n \"qrcode\": null,\n \"qrcode_text\": null,\n \"status\": null,\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"14E870A66B4B46DA8947DB8661590009\",\n \"description\": \"Desc\",\n \"price_cents\": 500,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:27:43-03:00\",\n \"updated_at\": \"2025-04-02T13:27:43-03:00\",\n \"price\": \"R$ 5,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": null\n },\n {\n \"id\": \"EBB161AAB22849BFA047D5F1DF55AEE9\",\n \"due_date\": \"2025-04-02\",\n \"currency\": \"BRL\",\n \"discount_cents\": 24,\n \"email\": \"email@iugu.com\",\n \"notification_url\": null,\n \"return_url\": \"https://google.com\",\n \"status\": \"pending\",\n \"tax_cents\": null,\n \"total_cents\": 376,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"payable_with\": \"all\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-04-02T13:15:07-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": \"John\",\n \"payer_email\": null,\n \"payer_cpf_cnpj\": \"11343675030\",\n \"payer_phone\": \"971113024\",\n \"payer_phone_prefix\": \"11\",\n \"payer_address_zip_code\": \"13056-344\",\n \"payer_address_street\": \"Rua Antônio Nunes\",\n \"payer_address_district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"payer_address_city\": \"Campinas\",\n \"payer_address_state\": \"SP\",\n \"payer_address_number\": \"21\",\n \"payer_address_complement\": \"AP1702\",\n \"payer_address_country\": \"Brasil\",\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"barcode_v1\",\n \"value\": \"40197103900000003762025092000000000000200864\"\n },\n {\n \"variable\": \"barcode_version\",\n \"value\": \"1\"\n },\n {\n \"variable\": \"payer.address.city\",\n \"value\": \"Campinas\"\n },\n {\n \"variable\": \"payer.address.complement\",\n \"value\": \"AP1702\"\n },\n {\n \"variable\": \"payer.address.country\",\n \"value\": \"Brasil\"\n },\n {\n \"variable\": \"payer.address.district\",\n \"value\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\"\n },\n {\n \"variable\": \"payer.address.number\",\n \"value\": \"21\"\n },\n {\n \"variable\": \"payer.address.state\",\n \"value\": \"SP\"\n },\n {\n \"variable\": \"payer.address.street\",\n \"value\": \"Rua Antônio Nunes\"\n },\n {\n \"variable\": \"payer.address.zip_code\",\n \"value\": \"13056-344\"\n },\n {\n \"variable\": \"payer.cpf_cnpj\",\n \"value\": \"11343675030\"\n },\n {\n \"variable\": \"payer.name\",\n \"value\": \"John\"\n },\n {\n \"variable\": \"payer.phone\",\n \"value\": \"971113024\"\n },\n {\n \"variable\": \"payer.phone_prefix\",\n \"value\": \"11\"\n },\n {\n \"variable\": \"payment_data.transaction_number\",\n \"value\": \"412825250927504\"\n }\n ],\n \"custom_variables\": [\n {\n \"name\": \"Minha variável\",\n \"value\": \"DSAY312HKD312JH\"\n }\n ],\n \"logs\": [],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": null,\n \"bank_account_number\": null,\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 3,76\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"financial_return_date\": null,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": \"R$ 0,24\",\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 1,\n \"created_at\": \"02/04, 13:14\",\n \"created_at_iso\": \"2025-04-02T13:14:26-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": \"412825250927504\",\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": {\n \"digitable_line\": \"40192025089200000000700002008647710390000000376\",\n \"barcode_data\": \"40197103900000003762025092000000000000200864\",\n \"barcode\": \"https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode\",\n \"bank_slip_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip\",\n \"bank_slip_pdf_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf\",\n \"bank_slip_bank\": 401,\n \"bank_slip_status\": \"registered\",\n \"bank_slip_error_code\": null,\n \"bank_slip_error_message\": null,\n \"recipient_cpf_cnpj\": \"42135294870\"\n },\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"qrcode_text\": \"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR592NOME DA CONTA6009SAO PAULO62070503***630405E6\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"03B951855B92410890A0EA5742636E96\",\n \"description\": \"Nome do Item\",\n \"price_cents\": 300,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 3,00\"\n },\n {\n \"id\": \"36E1C5DFFD834DB6A06B67DA76363C51\",\n \"description\": \"Nome do Item 2\",\n \"price_cents\": 100,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 1,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": [\n {\n \"id\": \"AB1B22F356464105A3C17BA18A640BA9\",\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"recipient_account_id\": \"E638DCED176240E4A510510C065FB52D\",\n \"cents\": 10,\n \"percent\": 1,\n \"credit_card_cents\": null,\n \"credit_card_percent\": null,\n \"bank_slip_cents\": null,\n \"bank_slip_percent\": null,\n \"pix_cents\": null,\n \"pix_percent\": null,\n \"permit_aggregated\": true,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"credit_card_1x_cents\": null,\n \"credit_card_2x_cents\": null,\n \"credit_card_3x_cents\": null,\n \"credit_card_4x_cents\": null,\n \"credit_card_5x_cents\": null,\n \"credit_card_6x_cents\": null,\n \"credit_card_7x_cents\": null,\n \"credit_card_8x_cents\": null,\n \"credit_card_9x_cents\": null,\n \"credit_card_10x_cents\": null,\n \"credit_card_11x_cents\": null,\n \"credit_card_12x_cents\": null,\n \"credit_card_1x_percent\": null,\n \"credit_card_2x_percent\": null,\n \"credit_card_3x_percent\": null,\n \"credit_card_4x_percent\": null,\n \"credit_card_5x_percent\": null,\n \"credit_card_6x_percent\": null,\n \"credit_card_7x_percent\": null,\n \"credit_card_8x_percent\": null,\n \"credit_card_9x_percent\": null,\n \"credit_card_10x_percent\": null,\n \"credit_card_11x_percent\": null,\n \"credit_card_12x_percent\": null,\n \"credit_card_13x_cents\": null,\n \"credit_card_14x_cents\": null,\n \"credit_card_15x_cents\": null,\n \"credit_card_16x_cents\": null,\n \"credit_card_17x_cents\": null,\n \"credit_card_18x_cents\": null,\n \"credit_card_13x_percent\": null,\n \"credit_card_14x_percent\": null,\n \"credit_card_15x_percent\": null,\n \"credit_card_16x_percent\": null,\n \"credit_card_17x_percent\": null,\n \"credit_card_18x_percent\": null\n }\n ]\n },\n {\n \"id\": \"FCC4824FA2D74194B1DA1669AE048097\",\n \"due_date\": \"2025-02-25\",\n \"currency\": \"BRL\",\n \"discount_cents\": null,\n \"email\": \"infra@email.com\",\n \"notification_url\": null,\n \"return_url\": null,\n \"status\": \"expired\",\n \"tax_cents\": null,\n \"total_cents\": 500,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"payable_with\": \"all\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-03-07T11:11:53-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": \"Nome do Pagador\",\n \"payer_email\": null,\n \"payer_cpf_cnpj\": \"11343675030\",\n \"payer_phone\": null,\n \"payer_phone_prefix\": null,\n \"payer_address_zip_code\": null,\n \"payer_address_street\": null,\n \"payer_address_district\": null,\n \"payer_address_city\": null,\n \"payer_address_state\": null,\n \"payer_address_number\": null,\n \"payer_address_complement\": null,\n \"payer_address_country\": null,\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": null,\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"barcode_v1\",\n \"value\": \"40199100300000005002025056000000000000279936\"\n },\n {\n \"variable\": \"barcode_version\",\n \"value\": \"1\"\n },\n {\n \"variable\": \"payer.cpf_cnpj\",\n \"value\": \"11343675030\"\n },\n {\n \"variable\": \"payer.name\",\n \"value\": \"Nome do Pagador\"\n },\n {\n \"variable\": \"payment_data.transaction_number\",\n \"value\": \"821637250569897\"\n }\n ],\n \"custom_variables\": [],\n \"logs\": [],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": null,\n \"bank_account_number\": null,\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"fcc4824f-a2d7-4194-b1da-1669ae048097-3e37\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/fcc4824f-a2d7-4194-b1da-1669ae048097-3e37\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 5,00\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"financial_return_date\": null,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": null,\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 3,\n \"created_at\": \"25/02, 18:12\",\n \"created_at_iso\": \"2025-02-25T18:12:54-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": \"07/03, 11:11\",\n \"expired_at_iso\": \"2025-03-07T11:11:53-03:00\",\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": \"821637250569897\",\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": null,\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/fcc4824f-a2d7-4194-b1da-1669ae048097-3e37\",\n \"qrcode_text\": \"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/FCC4824FA2D74194B1DA1669AE04809752040000530398654045.005802BR5924NOME DA CONTA6009SAO PAULO62070503***630421AF\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"698644B0F472488F966B60D535B54162\",\n \"description\": \"Nome do Item\",\n \"price_cents\": 500,\n \"quantity\": 1,\n \"created_at\": \"2025-02-25T18:12:54-03:00\",\n \"updated_at\": \"2025-02-25T18:12:54-03:00\",\n \"price\": \"R$ 5,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": null\n },\n {\n \"id\": \"0176EDCEBDF8494FBDD37264ED24718F\",\n \"due_date\": \"2025-02-26\",\n \"currency\": \"BRL\",\n \"discount_cents\": null,\n \"email\": \"infra@email.com\",\n \"notification_url\": null,\n \"return_url\": null,\n \"status\": \"expired\",\n \"tax_cents\": null,\n \"total_cents\": 500,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"payable_with\": \"all\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-03-08T11:41:40-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": \"Nome do Pagador\",\n \"payer_email\": null,\n \"payer_cpf_cnpj\": \"11343675030\",\n \"payer_phone\": null,\n \"payer_phone_prefix\": null,\n \"payer_address_zip_code\": null,\n \"payer_address_street\": null,\n \"payer_address_district\": null,\n \"payer_address_city\": null,\n \"payer_address_state\": null,\n \"payer_address_number\": null,\n \"payer_address_complement\": null,\n \"payer_address_country\": null,\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": null,\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"barcode_v1\",\n \"value\": \"40194100400000005002025056000000000000279743\"\n },\n {\n \"variable\": \"barcode_version\",\n \"value\": \"1\"\n },\n {\n \"variable\": \"payer.cpf_cnpj\",\n \"value\": \"11343675030\"\n },\n {\n \"variable\": \"payer.name\",\n \"value\": \"Nome do Pagador\"\n },\n {\n \"variable\": \"payment_data.transaction_number\",\n \"value\": \"512461250563520\"\n },\n {\n \"variable\": \"total_views\",\n \"value\": \"8\"\n }\n ],\n \"custom_variables\": [],\n \"logs\": [],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": null,\n \"bank_account_number\": null,\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"0176edce-bdf8-494f-bdd3-7264ed24718f-6c95\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/0176edce-bdf8-494f-bdd3-7264ed24718f-6c95\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 5,00\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"financial_return_date\": null,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": null,\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 3,\n \"created_at\": \"25/02, 18:12\",\n \"created_at_iso\": \"2025-02-25T18:12:06-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": \"08/03, 11:41\",\n \"expired_at_iso\": \"2025-03-08T11:41:40-03:00\",\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": \"512461250563520\",\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": null,\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/0176edce-bdf8-494f-bdd3-7264ed24718f-6c95\",\n \"qrcode_text\": \"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/0176EDCEBDF8494FBDD37264ED24718F52040000530398654045.005802BR5924NOME DA CONTA6009SAO PAULO62070503***63047C9A\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"419AC54498184DD9BD8DA581ECAE0079\",\n \"description\": \"Nome do Item\",\n \"price_cents\": 500,\n \"quantity\": 1,\n \"created_at\": \"2025-02-25T18:12:06-03:00\",\n \"updated_at\": \"2025-02-25T18:12:06-03:00\",\n \"price\": \"R$ 5,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": null\n },\n {\n \"id\": \"2B87F4980AED4535B0D5CF9B50E26737\",\n \"due_date\": \"2025-02-26\",\n \"currency\": \"BRL\",\n \"discount_cents\": null,\n \"email\": \"infra@email.com\",\n \"notification_url\": null,\n \"return_url\": null,\n \"status\": \"expired\",\n \"tax_cents\": null,\n \"total_cents\": 500,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"payable_with\": \"all\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-03-08T11:42:58-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": \"Nome do Pagador\",\n \"payer_email\": null,\n \"payer_cpf_cnpj\": \"11343675030\",\n \"payer_phone\": null,\n \"payer_phone_prefix\": null,\n \"payer_address_zip_code\": null,\n \"payer_address_street\": null,\n \"payer_address_district\": null,\n \"payer_address_city\": null,\n \"payer_address_state\": null,\n \"payer_address_number\": null,\n \"payer_address_complement\": null,\n \"payer_address_country\": null,\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": null,\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"barcode_v1\",\n \"value\": \"40195100400000005002025056000000000000279197\"\n },\n {\n \"variable\": \"barcode_version\",\n \"value\": \"1\"\n },\n {\n \"variable\": \"payer.cpf_cnpj\",\n \"value\": \"11343675030\"\n },\n {\n \"variable\": \"payer.name\",\n \"value\": \"Nome do Pagador\"\n },\n {\n \"variable\": \"payment_data.transaction_number\",\n \"value\": \"633770250565602\"\n },\n {\n \"variable\": \"total_views\",\n \"value\": \"1\"\n }\n ],\n \"custom_variables\": [],\n \"logs\": [],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": null,\n \"bank_account_number\": null,\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"2b87f498-0aed-4535-b0d5-cf9b50e26737-8069\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/2b87f498-0aed-4535-b0d5-cf9b50e26737-8069\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 5,00\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"financial_return_date\": null,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": null,\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 3,\n \"created_at\": \"25/02, 18:10\",\n \"created_at_iso\": \"2025-02-25T18:10:00-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": \"08/03, 11:42\",\n \"expired_at_iso\": \"2025-03-08T11:42:58-03:00\",\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": \"633770250565602\",\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": null,\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/2b87f498-0aed-4535-b0d5-cf9b50e26737-8069\",\n \"qrcode_text\": \"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/2B87F4980AED4535B0D5CF9B50E2673752040000530398654045.005802BR5924NOME DA CONTA6009SAO PAULO62070503***6304F07A\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"D3E9EDAAE2A6414B9B730A6832ECB1B3\",\n \"description\": \"Nome do Item\",\n \"price_cents\": 500,\n \"quantity\": 1,\n \"created_at\": \"2025-02-25T18:10:00-03:00\",\n \"updated_at\": \"2025-02-25T18:10:00-03:00\",\n \"price\": \"R$ 5,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": null\n }\n ],\n \"facets\": {\n \"late\": {\n \"_type\": \"filter\",\n \"count\": 0\n },\n \"status\": {\n \"_type\": \"terms\",\n \"missing\": 0,\n \"other\": 0,\n \"terms\": [\n {\n \"term\": \"expired\",\n \"count\": 43\n },\n {\n \"term\": \"canceled\",\n \"count\": 13\n },\n {\n \"term\": \"paid\",\n \"count\": 6\n },\n {\n \"term\": \"pending\",\n \"count\": 2\n },\n {\n \"term\": \"refunded\",\n \"count\": 2\n }\n ],\n \"total\": 66\n }\n },\n \"totalItems\": 66\n}" schema: type: object properties: items: type: array items: type: object properties: id: type: string example: ACD03D71D16249BAB49FC89EB6F8516F due_date: type: string example: '2025-04-07' currency: type: string example: BRL discount_cents: {} email: type: string example: email@iugu.com notification_url: {} return_url: {} status: type: string example: pending tax_cents: {} total_cents: type: integer example: 500 default: 0 total_paid_cents: type: integer example: 0 default: 0 taxes_paid_cents: {} paid_at: {} paid_cents: {} cc_emails: {} payable_with: type: string example: credit_card overpaid_cents: {} ignore_due_email: {} ignore_canceled_email: {} advance_fee_cents: {} commission_cents: {} early_payment_discount: type: boolean example: false default: true order_id: {} updated_at: type: string example: '2025-04-02T13:27:43-03:00' credit_card_brand: {} credit_card_bin: {} credit_card_last_4: {} credit_card_captured_at: {} credit_card_tid: {} external_reference: {} max_installments_value: {} payer_name: {} payer_email: {} payer_cpf_cnpj: {} payer_phone: {} payer_phone_prefix: {} payer_address_zip_code: {} payer_address_street: {} payer_address_district: {} payer_address_city: {} payer_address_state: {} payer_address_number: {} payer_address_complement: {} payer_address_country: {} late_payment_fine: type: integer example: 0 default: 0 late_payment_fine_cents: {} split_id: {} external_payment_id: {} external_payment_description: {} payment_booklet_id: {} subscription_id: {} variables: type: array items: type: object properties: {} custom_variables: type: array items: type: object properties: {} logs: type: array items: type: object properties: {} credit_card_transaction: {} account_id: type: string example: 44C5DC6376804D1FA792CBCA382105C1 bank_account_branch: {} bank_account_number: {} account_name: type: string example: Nome da Conta secure_id: type: string example: acd03d71-d162-49ba-b49f-c89eb6f8516f-5fa4 secure_url: type: string example: https://checkout.iugu.com/invoices/acd03d71-d162-49ba-b49f-c89eb6f8516f-5fa4 customer_id: {} customer_ref: {} customer_name: {} user_id: {} total: type: string example: R$ 5,00 taxes_paid: type: string example: R$ 0,00 total_paid: type: string example: R$ 0,00 total_overpaid: type: string example: R$ 0,00 total_refunded: type: string example: R$ 0,00 fine_cents: type: integer example: 0 default: 0 commission: type: string example: R$ 0,00 fines_on_occurrence_day: type: string example: R$ 0,00 total_on_occurrence_day: type: string example: R$ 0,00 fines_on_occurrence_day_cents: type: integer example: 0 default: 0 total_on_occurrence_day_cents: type: integer example: 0 default: 0 refunded_cents: type: integer example: 0 default: 0 remaining_captured_cents: type: integer example: 0 default: 0 financial_return_date: {} advance_fee: {} estimated_advance_fee: {} paid: type: string example: R$ 0,00 original_payment_id: {} double_payment_id: {} per_day_interest: type: boolean example: false default: true per_day_interest_value: {} per_day_interest_cents: type: integer example: 0 default: 0 interest: {} discount: {} duplicated_invoice_id: {} bank_slip_extra_due: type: integer example: 10 default: 0 created_at: type: string example: 02/04, 13:27 created_at_iso: type: string example: '2025-04-02T13:27:43-03:00' authorized_at: {} authorized_at_iso: {} expired_at: {} expired_at_iso: {} refunded_at: {} refunded_at_iso: {} canceled_at: {} canceled_at_iso: {} protested_at: {} protested_at_iso: {} chargeback_at: {} chargeback_at_iso: {} occurrence_date: {} refundable: {} installments: {} transaction_number: {} payment_method: {} financial_return_dates: {} bank_slip: {} pix: type: object properties: qrcode: {} qrcode_text: {} status: {} payer_cpf_cnpj: {} payer_name: {} end_to_end_id: {} end_to_end_refund_id: {} account_number_last_digits: {} items: type: array items: type: object properties: id: type: string example: 14E870A66B4B46DA8947DB8661590009 description: type: string example: Desc price_cents: type: integer example: 500 default: 0 quantity: type: integer example: 1 default: 0 created_at: type: string example: '2025-04-02T13:27:43-03:00' updated_at: type: string example: '2025-04-02T13:27:43-03:00' price: type: string example: R$ 5,00 early_payment_discounts: type: array items: type: object properties: {} split_rules: {} facets: type: object properties: late: type: object properties: _type: type: string example: filter count: type: integer example: 0 default: 0 status: type: object properties: _type: type: string example: terms missing: type: integer example: 0 default: 0 other: type: integer example: 0 default: 0 terms: type: array items: type: object properties: term: type: string example: expired count: type: integer example: 43 default: 0 total: type: integer example: 66 default: 0 totalItems: type: integer example: 66 default: 0 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Invoices servers: - url: https://api.iugu.com/v1 /invoices/{id}: get: summary: Consultar Fatura description: Retorna os dados de uma Fatura. operationId: buscar-fatura parameters: - name: id in: path description: ID da Fatura schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"EBB161AAB22849BFA047D5F1DF55AEE9\",\n \"due_date\": \"2025-04-02\",\n \"currency\": \"BRL\",\n \"discount_cents\": 24,\n \"email\": \"email@iugu.com\",\n \"items_total_cents\": 400,\n \"notification_url\": null,\n \"return_url\": \"https://google.com\",\n \"status\": \"pending\",\n \"tax_cents\": null,\n \"total_cents\": 376,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"financial_return_date\": null,\n \"payable_with\": \"all\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-04-02T13:15:07-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": \"John\",\n \"payer_email\": null,\n \"payer_cpf_cnpj\": \"11343675030\",\n \"payer_phone\": \"971113024\",\n \"payer_phone_prefix\": \"11\",\n \"payer_address_zip_code\": \"13056-344\",\n \"payer_address_street\": \"Rua Antônio Nunes\",\n \"payer_address_district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"payer_address_city\": \"Campinas\",\n \"payer_address_state\": \"SP\",\n \"payer_address_number\": \"21\",\n \"payer_address_complement\": \"AP1702\",\n \"payer_address_country\": \"Brasil\",\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"barcode_v1\",\n \"value\": \"40197103900000003762025092000000000000200864\"\n },\n {\n \"variable\": \"barcode_version\",\n \"value\": \"1\"\n },\n {\n \"variable\": \"payer.address.city\",\n \"value\": \"Campinas\"\n },\n {\n \"variable\": \"payer.address.complement\",\n \"value\": \"AP1702\"\n },\n {\n \"variable\": \"payer.address.country\",\n \"value\": \"Brasil\"\n },\n {\n \"variable\": \"payer.address.district\",\n \"value\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\"\n },\n {\n \"variable\": \"payer.address.number\",\n \"value\": \"21\"\n },\n {\n \"variable\": \"payer.address.state\",\n \"value\": \"SP\"\n },\n {\n \"variable\": \"payer.address.street\",\n \"value\": \"Rua Antônio Nunes\"\n },\n {\n \"variable\": \"payer.address.zip_code\",\n \"value\": \"13056-344\"\n },\n {\n \"variable\": \"payer.cpf_cnpj\",\n \"value\": \"11343675030\"\n },\n {\n \"variable\": \"payer.name\",\n \"value\": \"John\"\n },\n {\n \"variable\": \"payer.phone\",\n \"value\": \"971113024\"\n },\n {\n \"variable\": \"payer.phone_prefix\",\n \"value\": \"11\"\n },\n {\n \"variable\": \"payment_data.transaction_number\",\n \"value\": \"412825250927504\"\n }\n ],\n \"custom_variables\": [\n {\n \"name\": \"Minha variável\",\n \"value\": \"DSAY312HKD312JH\"\n }\n ],\n \"logs\": [\n {\n \"id\": \"F34952A91D364C1AA2C827F62615239D\",\n \"description\": \"Email de Fatura enviado!\",\n \"notes\": \"Fatura enviada com sucesso para: email@iugu.com\",\n \"created_at\": \"02/04, 13:14\"\n },\n {\n \"id\": \"63BD254B355D49F2850667053497DEB5\",\n \"description\": \"Fatura criada com sucesso!\",\n \"notes\": \"Fatura criada!\",\n \"created_at\": \"02/04, 13:14\"\n }\n ],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": \"0001\",\n \"bank_account_number\": \"2739435-0\",\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 3,76\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": \"R$ 0,24\",\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 1,\n \"created_at\": \"02/04, 13:14\",\n \"created_at_iso\": \"2025-04-02T13:14:26-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": 412825250927504,\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": {\n \"digitable_line\": \"40192025089200000000700002008647710390000000376\",\n \"barcode_data\": \"40197103900000003762025092000000000000200864\",\n \"barcode\": \"https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode\",\n \"bank_slip_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip\",\n \"bank_slip_pdf_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf\",\n \"bank_slip_bank\": 401,\n \"bank_slip_status\": \"registered\",\n \"bank_slip_error_code\": null,\n \"bank_slip_error_message\": null,\n \"recipient_cpf_cnpj\": \"42135294870\"\n },\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"qrcode_text\": \"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"03B951855B92410890A0EA5742636E96\",\n \"description\": \"Nome do Item\",\n \"price_cents\": 300,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 3,00\"\n },\n {\n \"id\": \"36E1C5DFFD834DB6A06B67DA76363C51\",\n \"description\": \"Nome do Item 2\",\n \"price_cents\": 100,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 1,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": [\n {\n \"id\": \"AB1B22F356464105A3C17BA18A640BA9\",\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"recipient_account_id\": \"E638DCED176240E4A510510C065FB52D\",\n \"cents\": 10,\n \"percent\": 1,\n \"credit_card_cents\": null,\n \"credit_card_percent\": null,\n \"bank_slip_cents\": null,\n \"bank_slip_percent\": null,\n \"pix_cents\": null,\n \"pix_percent\": null,\n \"permit_aggregated\": true,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"credit_card_1x_cents\": null,\n \"credit_card_2x_cents\": null,\n \"credit_card_3x_cents\": null,\n \"credit_card_4x_cents\": null,\n \"credit_card_5x_cents\": null,\n \"credit_card_6x_cents\": null,\n \"credit_card_7x_cents\": null,\n \"credit_card_8x_cents\": null,\n \"credit_card_9x_cents\": null,\n \"credit_card_10x_cents\": null,\n \"credit_card_11x_cents\": null,\n \"credit_card_12x_cents\": null,\n \"credit_card_1x_percent\": null,\n \"credit_card_2x_percent\": null,\n \"credit_card_3x_percent\": null,\n \"credit_card_4x_percent\": null,\n \"credit_card_5x_percent\": null,\n \"credit_card_6x_percent\": null,\n \"credit_card_7x_percent\": null,\n \"credit_card_8x_percent\": null,\n \"credit_card_9x_percent\": null,\n \"credit_card_10x_percent\": null,\n \"credit_card_11x_percent\": null,\n \"credit_card_12x_percent\": null,\n \"credit_card_13x_cents\": null,\n \"credit_card_14x_cents\": null,\n \"credit_card_15x_cents\": null,\n \"credit_card_16x_cents\": null,\n \"credit_card_17x_cents\": null,\n \"credit_card_18x_cents\": null,\n \"credit_card_13x_percent\": null,\n \"credit_card_14x_percent\": null,\n \"credit_card_15x_percent\": null,\n \"credit_card_16x_percent\": null,\n \"credit_card_17x_percent\": null,\n \"credit_card_18x_percent\": null\n }\n ]\n}" schema: type: object properties: id: type: string example: EBB161AAB22849BFA047D5F1DF55AEE9 due_date: type: string example: '2025-04-02' currency: type: string example: BRL discount_cents: type: integer example: 24 default: 0 email: type: string example: email@iugu.com items_total_cents: type: integer example: 400 default: 0 notification_url: {} return_url: type: string example: https://google.com status: type: string example: pending tax_cents: {} total_cents: type: integer example: 376 default: 0 total_paid_cents: type: integer example: 0 default: 0 taxes_paid_cents: {} paid_at: {} paid_cents: {} cc_emails: {} financial_return_date: {} payable_with: type: string example: all overpaid_cents: {} ignore_due_email: {} ignore_canceled_email: {} advance_fee_cents: {} commission_cents: {} early_payment_discount: type: boolean example: false default: true order_id: {} updated_at: type: string example: '2025-04-02T13:15:07-03:00' credit_card_brand: {} credit_card_bin: {} credit_card_last_4: {} credit_card_captured_at: {} credit_card_tid: {} external_reference: {} max_installments_value: {} payer_name: type: string example: John payer_email: {} payer_cpf_cnpj: type: string example: '11343675030' payer_phone: type: string example: '971113024' payer_phone_prefix: type: string example: '11' payer_address_zip_code: type: string example: 13056-344 payer_address_street: type: string example: Rua Antônio Nunes payer_address_district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) payer_address_city: type: string example: Campinas payer_address_state: type: string example: SP payer_address_number: type: string example: '21' payer_address_complement: type: string example: AP1702 payer_address_country: type: string example: Brasil late_payment_fine: type: integer example: 0 default: 0 late_payment_fine_cents: {} split_id: type: string example: 3270D0BAB8074BDE98E382340338550C external_payment_id: {} external_payment_description: {} payment_booklet_id: {} subscription_id: {} variables: type: array items: type: object properties: variable: type: string example: barcode_v1 value: type: string example: '40197103900000003762025092000000000000200864' custom_variables: type: array items: type: object properties: name: type: string example: Minha variável value: type: string example: DSAY312HKD312JH logs: type: array items: type: object properties: id: type: string example: F34952A91D364C1AA2C827F62615239D description: type: string example: Email de Fatura enviado! notes: type: string example: 'Fatura enviada com sucesso para: email@iugu.com' created_at: type: string example: 02/04, 13:14 credit_card_transaction: {} account_id: type: string example: 44C5DC6376804D1FA792CBCA382105C1 bank_account_branch: type: string example: '0001' bank_account_number: type: string example: 2739435-0 account_name: type: string example: Nome da Conta secure_id: type: string example: ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 secure_url: type: string example: https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 customer_id: {} customer_ref: {} customer_name: {} user_id: {} total: type: string example: R$ 3,76 taxes_paid: type: string example: R$ 0,00 total_paid: type: string example: R$ 0,00 total_overpaid: type: string example: R$ 0,00 total_refunded: type: string example: R$ 0,00 fine_cents: type: integer example: 0 default: 0 commission: type: string example: R$ 0,00 fines_on_occurrence_day: type: string example: R$ 0,00 total_on_occurrence_day: type: string example: R$ 0,00 fines_on_occurrence_day_cents: type: integer example: 0 default: 0 total_on_occurrence_day_cents: type: integer example: 0 default: 0 refunded_cents: type: integer example: 0 default: 0 remaining_captured_cents: type: integer example: 0 default: 0 advance_fee: {} estimated_advance_fee: {} paid: type: string example: R$ 0,00 original_payment_id: {} double_payment_id: {} per_day_interest: type: boolean example: false default: true per_day_interest_value: {} per_day_interest_cents: type: integer example: 0 default: 0 interest: {} discount: type: string example: R$ 0,24 duplicated_invoice_id: {} bank_slip_extra_due: type: integer example: 1 default: 0 created_at: type: string example: 02/04, 13:14 created_at_iso: type: string example: '2025-04-02T13:14:26-03:00' authorized_at: {} authorized_at_iso: {} expired_at: {} expired_at_iso: {} refunded_at: {} refunded_at_iso: {} canceled_at: {} canceled_at_iso: {} protested_at: {} protested_at_iso: {} chargeback_at: {} chargeback_at_iso: {} occurrence_date: {} refundable: {} installments: {} transaction_number: type: integer example: 412825250927504 default: 0 payment_method: {} financial_return_dates: {} bank_slip: type: object properties: digitable_line: type: string example: '40192025089200000000700002008647710390000000376' barcode_data: type: string example: '40197103900000003762025092000000000000200864' barcode: type: string example: https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode bank_slip_url: type: string example: https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip bank_slip_pdf_url: type: string example: https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf bank_slip_bank: type: integer example: 401 default: 0 bank_slip_status: type: string example: registered bank_slip_error_code: {} bank_slip_error_message: {} recipient_cpf_cnpj: type: string example: '42135294870' pix: type: object properties: qrcode: type: string example: https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 qrcode_text: type: string example: 00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6 status: type: string example: qr_code_created payer_cpf_cnpj: {} payer_name: {} end_to_end_id: {} end_to_end_refund_id: {} account_number_last_digits: {} items: type: array items: type: object properties: id: type: string example: 03B951855B92410890A0EA5742636E96 description: type: string example: Nome do Item price_cents: type: integer example: 300 default: 0 quantity: type: integer example: 1 default: 0 created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' price: type: string example: R$ 3,00 early_payment_discounts: type: array items: type: object properties: {} split_rules: type: array items: type: object properties: id: type: string example: AB1B22F356464105A3C17BA18A640BA9 split_id: type: string example: 3270D0BAB8074BDE98E382340338550C recipient_account_id: type: string example: E638DCED176240E4A510510C065FB52D cents: type: integer example: 10 default: 0 percent: type: integer example: 1 default: 0 credit_card_cents: {} credit_card_percent: {} bank_slip_cents: {} bank_slip_percent: {} pix_cents: {} pix_percent: {} permit_aggregated: type: boolean example: true default: true created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' credit_card_1x_cents: {} credit_card_2x_cents: {} credit_card_3x_cents: {} credit_card_4x_cents: {} credit_card_5x_cents: {} credit_card_6x_cents: {} credit_card_7x_cents: {} credit_card_8x_cents: {} credit_card_9x_cents: {} credit_card_10x_cents: {} credit_card_11x_cents: {} credit_card_12x_cents: {} credit_card_1x_percent: {} credit_card_2x_percent: {} credit_card_3x_percent: {} credit_card_4x_percent: {} credit_card_5x_percent: {} credit_card_6x_percent: {} credit_card_7x_percent: {} credit_card_8x_percent: {} credit_card_9x_percent: {} credit_card_10x_percent: {} credit_card_11x_percent: {} credit_card_12x_percent: {} credit_card_13x_cents: {} credit_card_14x_cents: {} credit_card_15x_cents: {} credit_card_16x_cents: {} credit_card_17x_cents: {} credit_card_18x_cents: {} credit_card_13x_percent: {} credit_card_14x_percent: {} credit_card_15x_percent: {} credit_card_16x_percent: {} credit_card_17x_percent: {} credit_card_18x_percent: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Invoices servers: - url: https://api.iugu.com/v1 /invoices/{id}/cancel: put: summary: Cancelar Fatura description: 'Cancela uma Fatura. Os status possíveis para cancelamento: Em análise, pendente e expirada.' operationId: cancelar parameters: - name: id in: path description: ID da Fatura schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"EBB161AAB22849BFA047D5F1DF55AEE9\",\n \"due_date\": \"2025-04-02\",\n \"currency\": \"BRL\",\n \"discount_cents\": 24,\n \"email\": \"email@iugu.com\",\n \"items_total_cents\": 400,\n \"notification_url\": null,\n \"return_url\": \"https://google.com\",\n \"status\": \"canceled\",\n \"tax_cents\": null,\n \"total_cents\": 376,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"financial_return_date\": null,\n \"payable_with\": \"all\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-04-02T13:14:27-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": \"John\",\n \"payer_email\": null,\n \"payer_cpf_cnpj\": \"11343675030\",\n \"payer_phone\": \"971113024\",\n \"payer_phone_prefix\": \"11\",\n \"payer_address_zip_code\": \"13056-344\",\n \"payer_address_street\": \"Rua Antônio Nunes\",\n \"payer_address_district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"payer_address_city\": \"Campinas\",\n \"payer_address_state\": \"SP\",\n \"payer_address_number\": \"21\",\n \"payer_address_complement\": \"AP1702\",\n \"payer_address_country\": \"Brasil\",\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"barcode_v1\",\n \"value\": \"40197103900000003762025092000000000000200864\"\n },\n {\n \"variable\": \"barcode_version\",\n \"value\": \"1\"\n },\n {\n \"variable\": \"payer.address.city\",\n \"value\": \"Campinas\"\n },\n {\n \"variable\": \"payer.address.complement\",\n \"value\": \"AP1702\"\n },\n {\n \"variable\": \"payer.address.country\",\n \"value\": \"Brasil\"\n },\n {\n \"variable\": \"payer.address.district\",\n \"value\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\"\n },\n {\n \"variable\": \"payer.address.number\",\n \"value\": \"21\"\n },\n {\n \"variable\": \"payer.address.state\",\n \"value\": \"SP\"\n },\n {\n \"variable\": \"payer.address.street\",\n \"value\": \"Rua Antônio Nunes\"\n },\n {\n \"variable\": \"payer.address.zip_code\",\n \"value\": \"13056-344\"\n },\n {\n \"variable\": \"payer.cpf_cnpj\",\n \"value\": \"11343675030\"\n },\n {\n \"variable\": \"payer.name\",\n \"value\": \"John\"\n },\n {\n \"variable\": \"payer.phone\",\n \"value\": \"971113024\"\n },\n {\n \"variable\": \"payer.phone_prefix\",\n \"value\": \"11\"\n },\n {\n \"variable\": \"payment_data.transaction_number\",\n \"value\": \"412825250927504\"\n }\n ],\n \"custom_variables\": [\n {\n \"name\": \"Minha variável\",\n \"value\": \"DSAY312HKD312JH\"\n }\n ],\n \"logs\": [\n {\n \"id\": \"F34952A91D364C1AA2C827F62615239D\",\n \"description\": \"Email de Fatura enviado!\",\n \"notes\": \"Fatura enviada com sucesso para: email@iugu.com\",\n \"created_at\": \"02/04, 13:14\"\n },\n {\n \"id\": \"63BD254B355D49F2850667053497DEB5\",\n \"description\": \"Fatura criada com sucesso!\",\n \"notes\": \"Fatura criada!\",\n \"created_at\": \"02/04, 13:14\"\n }\n ],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": \"0001\",\n \"bank_account_number\": \"2739435-0\",\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 3,76\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": \"R$ 0,24\",\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 1,\n \"created_at\": \"02/04, 13:14\",\n \"created_at_iso\": \"2025-04-02T13:14:26-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": 412825250927504,\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": {\n \"digitable_line\": \"40192025089200000000700002008647710390000000376\",\n \"barcode_data\": \"40197103900000003762025092000000000000200864\",\n \"barcode\": \"https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode\",\n \"bank_slip_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip\",\n \"bank_slip_pdf_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf\",\n \"bank_slip_bank\": 401,\n \"bank_slip_status\": \"pending\",\n \"bank_slip_error_code\": null,\n \"bank_slip_error_message\": null,\n \"recipient_cpf_cnpj\": \"42135294870\"\n },\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"qrcode_text\": \"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"03B951855B92410890A0EA5742636E96\",\n \"description\": \"Nome do Item\",\n \"price_cents\": 300,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 3,00\"\n },\n {\n \"id\": \"36E1C5DFFD834DB6A06B67DA76363C51\",\n \"description\": \"Nome do Item 2\",\n \"price_cents\": 100,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 1,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": [\n {\n \"id\": \"AB1B22F356464105A3C17BA18A640BA9\",\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"recipient_account_id\": \"E638DCED176240E4A510510C065FB52D\",\n \"cents\": 10,\n \"percent\": 1,\n \"credit_card_cents\": null,\n \"credit_card_percent\": null,\n \"bank_slip_cents\": null,\n \"bank_slip_percent\": null,\n \"pix_cents\": null,\n \"pix_percent\": null,\n \"permit_aggregated\": true,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"credit_card_1x_cents\": null,\n \"credit_card_2x_cents\": null,\n \"credit_card_3x_cents\": null,\n \"credit_card_4x_cents\": null,\n \"credit_card_5x_cents\": null,\n \"credit_card_6x_cents\": null,\n \"credit_card_7x_cents\": null,\n \"credit_card_8x_cents\": null,\n \"credit_card_9x_cents\": null,\n \"credit_card_10x_cents\": null,\n \"credit_card_11x_cents\": null,\n \"credit_card_12x_cents\": null,\n \"credit_card_1x_percent\": null,\n \"credit_card_2x_percent\": null,\n \"credit_card_3x_percent\": null,\n \"credit_card_4x_percent\": null,\n \"credit_card_5x_percent\": null,\n \"credit_card_6x_percent\": null,\n \"credit_card_7x_percent\": null,\n \"credit_card_8x_percent\": null,\n \"credit_card_9x_percent\": null,\n \"credit_card_10x_percent\": null,\n \"credit_card_11x_percent\": null,\n \"credit_card_12x_percent\": null,\n \"credit_card_13x_cents\": null,\n \"credit_card_14x_cents\": null,\n \"credit_card_15x_cents\": null,\n \"credit_card_16x_cents\": null,\n \"credit_card_17x_cents\": null,\n \"credit_card_18x_cents\": null,\n \"credit_card_13x_percent\": null,\n \"credit_card_14x_percent\": null,\n \"credit_card_15x_percent\": null,\n \"credit_card_16x_percent\": null,\n \"credit_card_17x_percent\": null,\n \"credit_card_18x_percent\": null\n }\n ]\n}" schema: type: object properties: id: type: string example: EBB161AAB22849BFA047D5F1DF55AEE9 due_date: type: string example: '2025-04-02' currency: type: string example: BRL discount_cents: type: integer example: 24 default: 0 email: type: string example: email@iugu.com items_total_cents: type: integer example: 400 default: 0 notification_url: {} return_url: type: string example: https://google.com status: type: string example: canceled tax_cents: {} total_cents: type: integer example: 376 default: 0 total_paid_cents: type: integer example: 0 default: 0 taxes_paid_cents: {} paid_at: {} paid_cents: {} cc_emails: {} financial_return_date: {} payable_with: type: string example: all overpaid_cents: {} ignore_due_email: {} ignore_canceled_email: {} advance_fee_cents: {} commission_cents: {} early_payment_discount: type: boolean example: false default: true order_id: {} updated_at: type: string example: '2025-04-02T13:14:27-03:00' credit_card_brand: {} credit_card_bin: {} credit_card_last_4: {} credit_card_captured_at: {} credit_card_tid: {} external_reference: {} max_installments_value: {} payer_name: type: string example: John payer_email: {} payer_cpf_cnpj: type: string example: '11343675030' payer_phone: type: string example: '971113024' payer_phone_prefix: type: string example: '11' payer_address_zip_code: type: string example: 13056-344 payer_address_street: type: string example: Rua Antônio Nunes payer_address_district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) payer_address_city: type: string example: Campinas payer_address_state: type: string example: SP payer_address_number: type: string example: '21' payer_address_complement: type: string example: AP1702 payer_address_country: type: string example: Brasil late_payment_fine: type: integer example: 0 default: 0 late_payment_fine_cents: {} split_id: type: string example: 3270D0BAB8074BDE98E382340338550C external_payment_id: {} external_payment_description: {} payment_booklet_id: {} subscription_id: {} variables: type: array items: type: object properties: variable: type: string example: barcode_v1 value: type: string example: '40197103900000003762025092000000000000200864' custom_variables: type: array items: type: object properties: name: type: string example: Minha variável value: type: string example: DSAY312HKD312JH logs: type: array items: type: object properties: id: type: string example: F34952A91D364C1AA2C827F62615239D description: type: string example: Email de Fatura enviado! notes: type: string example: 'Fatura enviada com sucesso para: email@iugu.com' created_at: type: string example: 02/04, 13:14 credit_card_transaction: {} account_id: type: string example: 44C5DC6376804D1FA792CBCA382105C1 bank_account_branch: type: string example: '0001' bank_account_number: type: string example: 2739435-0 account_name: type: string example: Nome da Conta secure_id: type: string example: ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 secure_url: type: string example: https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 customer_id: {} customer_ref: {} customer_name: {} user_id: {} total: type: string example: R$ 3,76 taxes_paid: type: string example: R$ 0,00 total_paid: type: string example: R$ 0,00 total_overpaid: type: string example: R$ 0,00 total_refunded: type: string example: R$ 0,00 fine_cents: type: integer example: 0 default: 0 commission: type: string example: R$ 0,00 fines_on_occurrence_day: type: string example: R$ 0,00 total_on_occurrence_day: type: string example: R$ 0,00 fines_on_occurrence_day_cents: type: integer example: 0 default: 0 total_on_occurrence_day_cents: type: integer example: 0 default: 0 refunded_cents: type: integer example: 0 default: 0 remaining_captured_cents: type: integer example: 0 default: 0 advance_fee: {} estimated_advance_fee: {} paid: type: string example: R$ 0,00 original_payment_id: {} double_payment_id: {} per_day_interest: type: boolean example: false default: true per_day_interest_value: {} per_day_interest_cents: type: integer example: 0 default: 0 interest: {} discount: type: string example: R$ 0,24 duplicated_invoice_id: {} bank_slip_extra_due: type: integer example: 1 default: 0 created_at: type: string example: 02/04, 13:14 created_at_iso: type: string example: '2025-04-02T13:14:26-03:00' authorized_at: {} authorized_at_iso: {} expired_at: {} expired_at_iso: {} refunded_at: {} refunded_at_iso: {} canceled_at: {} canceled_at_iso: {} protested_at: {} protested_at_iso: {} chargeback_at: {} chargeback_at_iso: {} occurrence_date: {} refundable: {} installments: {} transaction_number: type: integer example: 412825250927504 default: 0 payment_method: {} financial_return_dates: {} bank_slip: type: object properties: digitable_line: type: string example: '40192025089200000000700002008647710390000000376' barcode_data: type: string example: '40197103900000003762025092000000000000200864' barcode: type: string example: https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode bank_slip_url: type: string example: https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip bank_slip_pdf_url: type: string example: https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf bank_slip_bank: type: integer example: 401 default: 0 bank_slip_status: type: string example: pending bank_slip_error_code: {} bank_slip_error_message: {} recipient_cpf_cnpj: type: string example: '42135294870' pix: type: object properties: qrcode: type: string example: https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 qrcode_text: type: string example: 00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6 status: type: string example: qr_code_created payer_cpf_cnpj: {} payer_name: {} end_to_end_id: {} end_to_end_refund_id: {} account_number_last_digits: {} items: type: array items: type: object properties: id: type: string example: 03B951855B92410890A0EA5742636E96 description: type: string example: Nome do Item price_cents: type: integer example: 300 default: 0 quantity: type: integer example: 1 default: 0 created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' price: type: string example: R$ 3,00 early_payment_discounts: type: array items: type: object properties: {} split_rules: type: array items: type: object properties: id: type: string example: AB1B22F356464105A3C17BA18A640BA9 split_id: type: string example: 3270D0BAB8074BDE98E382340338550C recipient_account_id: type: string example: E638DCED176240E4A510510C065FB52D cents: type: integer example: 10 default: 0 percent: type: integer example: 1 default: 0 credit_card_cents: {} credit_card_percent: {} bank_slip_cents: {} bank_slip_percent: {} pix_cents: {} pix_percent: {} permit_aggregated: type: boolean example: true default: true created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' credit_card_1x_cents: {} credit_card_2x_cents: {} credit_card_3x_cents: {} credit_card_4x_cents: {} credit_card_5x_cents: {} credit_card_6x_cents: {} credit_card_7x_cents: {} credit_card_8x_cents: {} credit_card_9x_cents: {} credit_card_10x_cents: {} credit_card_11x_cents: {} credit_card_12x_cents: {} credit_card_1x_percent: {} credit_card_2x_percent: {} credit_card_3x_percent: {} credit_card_4x_percent: {} credit_card_5x_percent: {} credit_card_6x_percent: {} credit_card_7x_percent: {} credit_card_8x_percent: {} credit_card_9x_percent: {} credit_card_10x_percent: {} credit_card_11x_percent: {} credit_card_12x_percent: {} credit_card_13x_cents: {} credit_card_14x_cents: {} credit_card_15x_cents: {} credit_card_16x_cents: {} credit_card_17x_cents: {} credit_card_18x_cents: {} credit_card_13x_percent: {} credit_card_14x_percent: {} credit_card_15x_percent: {} credit_card_16x_percent: {} credit_card_17x_percent: {} credit_card_18x_percent: {} '404': description: '404' content: application/json: examples: Invoice Not Found: value: "{\n \"errors\": \"Invoice Not Found\"\n}" schema: type: object properties: errors: type: string example: Invoice Not Found deprecated: false tags: - Invoices servers: - url: https://api.iugu.com/v1 /invoices/{id}/capture: post: summary: Capturar Fatura description: 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 operationId: capturar-fatura parameters: - name: id in: path description: ID da Fatura schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"EBB161AAB22849BFA047D5F1DF55AEE9\",\n \"due_date\": \"2025-04-02\",\n \"currency\": \"BRL\",\n \"discount_cents\": 24,\n \"email\": \"email@iugu.com\",\n \"items_total_cents\": 400,\n \"notification_url\": null,\n \"return_url\": \"https://google.com\",\n \"status\": \"paid\",\n \"tax_cents\": null,\n \"total_cents\": 376,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"financial_return_date\": null,\n \"payable_with\": \"all\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-04-02T13:14:27-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": \"John\",\n \"payer_email\": null,\n \"payer_cpf_cnpj\": \"11343675030\",\n \"payer_phone\": \"971113024\",\n \"payer_phone_prefix\": \"11\",\n \"payer_address_zip_code\": \"13056-344\",\n \"payer_address_street\": \"Rua Antônio Nunes\",\n \"payer_address_district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"payer_address_city\": \"Campinas\",\n \"payer_address_state\": \"SP\",\n \"payer_address_number\": \"21\",\n \"payer_address_complement\": \"AP1702\",\n \"payer_address_country\": \"Brasil\",\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"barcode_v1\",\n \"value\": \"40197103900000003762025092000000000000200864\"\n },\n {\n \"variable\": \"barcode_version\",\n \"value\": \"1\"\n },\n {\n \"variable\": \"payer.address.city\",\n \"value\": \"Campinas\"\n },\n {\n \"variable\": \"payer.address.complement\",\n \"value\": \"AP1702\"\n },\n {\n \"variable\": \"payer.address.country\",\n \"value\": \"Brasil\"\n },\n {\n \"variable\": \"payer.address.district\",\n \"value\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\"\n },\n {\n \"variable\": \"payer.address.number\",\n \"value\": \"21\"\n },\n {\n \"variable\": \"payer.address.state\",\n \"value\": \"SP\"\n },\n {\n \"variable\": \"payer.address.street\",\n \"value\": \"Rua Antônio Nunes\"\n },\n {\n \"variable\": \"payer.address.zip_code\",\n \"value\": \"13056-344\"\n },\n {\n \"variable\": \"payer.cpf_cnpj\",\n \"value\": \"11343675030\"\n },\n {\n \"variable\": \"payer.name\",\n \"value\": \"John\"\n },\n {\n \"variable\": \"payer.phone\",\n \"value\": \"971113024\"\n },\n {\n \"variable\": \"payer.phone_prefix\",\n \"value\": \"11\"\n },\n {\n \"variable\": \"payment_data.transaction_number\",\n \"value\": \"412825250927504\"\n }\n ],\n \"custom_variables\": [\n {\n \"name\": \"Minha variável\",\n \"value\": \"DSAY312HKD312JH\"\n }\n ],\n \"logs\": [\n {\n \"id\": \"F34952A91D364C1AA2C827F62615239D\",\n \"description\": \"Email de Fatura enviado!\",\n \"notes\": \"Fatura enviada com sucesso para: email@iugu.com\",\n \"created_at\": \"02/04, 13:14\"\n },\n {\n \"id\": \"63BD254B355D49F2850667053497DEB5\",\n \"description\": \"Fatura criada com sucesso!\",\n \"notes\": \"Fatura criada!\",\n \"created_at\": \"02/04, 13:14\"\n }\n ],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": \"0001\",\n \"bank_account_number\": \"2739435-0\",\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 3,76\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": \"R$ 0,24\",\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 1,\n \"created_at\": \"02/04, 13:14\",\n \"created_at_iso\": \"2025-04-02T13:14:26-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": 412825250927504,\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": {\n \"digitable_line\": \"40192025089200000000700002008647710390000000376\",\n \"barcode_data\": \"40197103900000003762025092000000000000200864\",\n \"barcode\": \"https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode\",\n \"bank_slip_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip\",\n \"bank_slip_pdf_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf\",\n \"bank_slip_bank\": 401,\n \"bank_slip_status\": \"pending\",\n \"bank_slip_error_code\": null,\n \"bank_slip_error_message\": null,\n \"recipient_cpf_cnpj\": \"42135294870\"\n },\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"qrcode_text\": \"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"03B951855B92410890A0EA5742636E96\",\n \"description\": \"Nome do Item\",\n \"price_cents\": 300,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 3,00\"\n },\n {\n \"id\": \"36E1C5DFFD834DB6A06B67DA76363C51\",\n \"description\": \"Nome do Item 2\",\n \"price_cents\": 100,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 1,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": [\n {\n \"id\": \"AB1B22F356464105A3C17BA18A640BA9\",\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"recipient_account_id\": \"E638DCED176240E4A510510C065FB52D\",\n \"cents\": 10,\n \"percent\": 1,\n \"credit_card_cents\": null,\n \"credit_card_percent\": null,\n \"bank_slip_cents\": null,\n \"bank_slip_percent\": null,\n \"pix_cents\": null,\n \"pix_percent\": null,\n \"permit_aggregated\": true,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"credit_card_1x_cents\": null,\n \"credit_card_2x_cents\": null,\n \"credit_card_3x_cents\": null,\n \"credit_card_4x_cents\": null,\n \"credit_card_5x_cents\": null,\n \"credit_card_6x_cents\": null,\n \"credit_card_7x_cents\": null,\n \"credit_card_8x_cents\": null,\n \"credit_card_9x_cents\": null,\n \"credit_card_10x_cents\": null,\n \"credit_card_11x_cents\": null,\n \"credit_card_12x_cents\": null,\n \"credit_card_1x_percent\": null,\n \"credit_card_2x_percent\": null,\n \"credit_card_3x_percent\": null,\n \"credit_card_4x_percent\": null,\n \"credit_card_5x_percent\": null,\n \"credit_card_6x_percent\": null,\n \"credit_card_7x_percent\": null,\n \"credit_card_8x_percent\": null,\n \"credit_card_9x_percent\": null,\n \"credit_card_10x_percent\": null,\n \"credit_card_11x_percent\": null,\n \"credit_card_12x_percent\": null,\n \"credit_card_13x_cents\": null,\n \"credit_card_14x_cents\": null,\n \"credit_card_15x_cents\": null,\n \"credit_card_16x_cents\": null,\n \"credit_card_17x_cents\": null,\n \"credit_card_18x_cents\": null,\n \"credit_card_13x_percent\": null,\n \"credit_card_14x_percent\": null,\n \"credit_card_15x_percent\": null,\n \"credit_card_16x_percent\": null,\n \"credit_card_17x_percent\": null,\n \"credit_card_18x_percent\": null\n }\n ]\n}" schema: type: object properties: id: type: string example: EBB161AAB22849BFA047D5F1DF55AEE9 due_date: type: string example: '2025-04-02' currency: type: string example: BRL discount_cents: type: integer example: 24 default: 0 email: type: string example: email@iugu.com items_total_cents: type: integer example: 400 default: 0 notification_url: {} return_url: type: string example: https://google.com status: type: string example: paid tax_cents: {} total_cents: type: integer example: 376 default: 0 total_paid_cents: type: integer example: 0 default: 0 taxes_paid_cents: {} paid_at: {} paid_cents: {} cc_emails: {} financial_return_date: {} payable_with: type: string example: all overpaid_cents: {} ignore_due_email: {} ignore_canceled_email: {} advance_fee_cents: {} commission_cents: {} early_payment_discount: type: boolean example: false default: true order_id: {} updated_at: type: string example: '2025-04-02T13:14:27-03:00' credit_card_brand: {} credit_card_bin: {} credit_card_last_4: {} credit_card_captured_at: {} credit_card_tid: {} external_reference: {} max_installments_value: {} payer_name: type: string example: John payer_email: {} payer_cpf_cnpj: type: string example: '11343675030' payer_phone: type: string example: '971113024' payer_phone_prefix: type: string example: '11' payer_address_zip_code: type: string example: 13056-344 payer_address_street: type: string example: Rua Antônio Nunes payer_address_district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) payer_address_city: type: string example: Campinas payer_address_state: type: string example: SP payer_address_number: type: string example: '21' payer_address_complement: type: string example: AP1702 payer_address_country: type: string example: Brasil late_payment_fine: type: integer example: 0 default: 0 late_payment_fine_cents: {} split_id: type: string example: 3270D0BAB8074BDE98E382340338550C external_payment_id: {} external_payment_description: {} payment_booklet_id: {} subscription_id: {} variables: type: array items: type: object properties: variable: type: string example: barcode_v1 value: type: string example: '40197103900000003762025092000000000000200864' custom_variables: type: array items: type: object properties: name: type: string example: Minha variável value: type: string example: DSAY312HKD312JH logs: type: array items: type: object properties: id: type: string example: F34952A91D364C1AA2C827F62615239D description: type: string example: Email de Fatura enviado! notes: type: string example: 'Fatura enviada com sucesso para: email@iugu.com' created_at: type: string example: 02/04, 13:14 credit_card_transaction: {} account_id: type: string example: 44C5DC6376804D1FA792CBCA382105C1 bank_account_branch: type: string example: '0001' bank_account_number: type: string example: 2739435-0 account_name: type: string example: Nome da Conta secure_id: type: string example: ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 secure_url: type: string example: https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 customer_id: {} customer_ref: {} customer_name: {} user_id: {} total: type: string example: R$ 3,76 taxes_paid: type: string example: R$ 0,00 total_paid: type: string example: R$ 0,00 total_overpaid: type: string example: R$ 0,00 total_refunded: type: string example: R$ 0,00 fine_cents: type: integer example: 0 default: 0 commission: type: string example: R$ 0,00 fines_on_occurrence_day: type: string example: R$ 0,00 total_on_occurrence_day: type: string example: R$ 0,00 fines_on_occurrence_day_cents: type: integer example: 0 default: 0 total_on_occurrence_day_cents: type: integer example: 0 default: 0 refunded_cents: type: integer example: 0 default: 0 remaining_captured_cents: type: integer example: 0 default: 0 advance_fee: {} estimated_advance_fee: {} paid: type: string example: R$ 0,00 original_payment_id: {} double_payment_id: {} per_day_interest: type: boolean example: false default: true per_day_interest_value: {} per_day_interest_cents: type: integer example: 0 default: 0 interest: {} discount: type: string example: R$ 0,24 duplicated_invoice_id: {} bank_slip_extra_due: type: integer example: 1 default: 0 created_at: type: string example: 02/04, 13:14 created_at_iso: type: string example: '2025-04-02T13:14:26-03:00' authorized_at: {} authorized_at_iso: {} expired_at: {} expired_at_iso: {} refunded_at: {} refunded_at_iso: {} canceled_at: {} canceled_at_iso: {} protested_at: {} protested_at_iso: {} chargeback_at: {} chargeback_at_iso: {} occurrence_date: {} refundable: {} installments: {} transaction_number: type: integer example: 412825250927504 default: 0 payment_method: {} financial_return_dates: {} bank_slip: type: object properties: digitable_line: type: string example: '40192025089200000000700002008647710390000000376' barcode_data: type: string example: '40197103900000003762025092000000000000200864' barcode: type: string example: https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode bank_slip_url: type: string example: https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip bank_slip_pdf_url: type: string example: https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf bank_slip_bank: type: integer example: 401 default: 0 bank_slip_status: type: string example: pending bank_slip_error_code: {} bank_slip_error_message: {} recipient_cpf_cnpj: type: string example: '42135294870' pix: type: object properties: qrcode: type: string example: https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 qrcode_text: type: string example: 00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6 status: type: string example: qr_code_created payer_cpf_cnpj: {} payer_name: {} end_to_end_id: {} end_to_end_refund_id: {} account_number_last_digits: {} items: type: array items: type: object properties: id: type: string example: 03B951855B92410890A0EA5742636E96 description: type: string example: Nome do Item price_cents: type: integer example: 300 default: 0 quantity: type: integer example: 1 default: 0 created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' price: type: string example: R$ 3,00 early_payment_discounts: type: array items: type: object properties: {} split_rules: type: array items: type: object properties: id: type: string example: AB1B22F356464105A3C17BA18A640BA9 split_id: type: string example: 3270D0BAB8074BDE98E382340338550C recipient_account_id: type: string example: E638DCED176240E4A510510C065FB52D cents: type: integer example: 10 default: 0 percent: type: integer example: 1 default: 0 credit_card_cents: {} credit_card_percent: {} bank_slip_cents: {} bank_slip_percent: {} pix_cents: {} pix_percent: {} permit_aggregated: type: boolean example: true default: true created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' credit_card_1x_cents: {} credit_card_2x_cents: {} credit_card_3x_cents: {} credit_card_4x_cents: {} credit_card_5x_cents: {} credit_card_6x_cents: {} credit_card_7x_cents: {} credit_card_8x_cents: {} credit_card_9x_cents: {} credit_card_10x_cents: {} credit_card_11x_cents: {} credit_card_12x_cents: {} credit_card_1x_percent: {} credit_card_2x_percent: {} credit_card_3x_percent: {} credit_card_4x_percent: {} credit_card_5x_percent: {} credit_card_6x_percent: {} credit_card_7x_percent: {} credit_card_8x_percent: {} credit_card_9x_percent: {} credit_card_10x_percent: {} credit_card_11x_percent: {} credit_card_12x_percent: {} credit_card_13x_cents: {} credit_card_14x_cents: {} credit_card_15x_cents: {} credit_card_16x_cents: {} credit_card_17x_cents: {} credit_card_18x_cents: {} credit_card_13x_percent: {} credit_card_14x_percent: {} credit_card_15x_percent: {} credit_card_16x_percent: {} credit_card_17x_percent: {} credit_card_18x_percent: {} '400': description: '400' content: application/json: examples: Result: value: "{\n\n \"errors\": \"Apenas Faturas em análise podem ser capturadas\"\n\n}" schema: type: object properties: errors: type: string example: Apenas Faturas em análise podem ser capturadas deprecated: false tags: - Invoices servers: - url: https://api.iugu.com/v1 /invoices/{id}/duplicate: post: summary: Gerar 2ª Via de Fatura description: Gera a segunda via de uma fatura com o status "pendente". A fatura atual é cancelada e uma nova é criada com o mesmo status. operationId: gerar-segunda-via parameters: - name: id in: path description: ID da fatura schema: type: string required: true requestBody: content: application/json: schema: type: object required: - due_date properties: due_date: type: string description: Nova data de vencimento no formato AAAA-MM-DD. format: date items: type: array description: Adicione, altere ou remova itens da nova fatura. Para remover, envie "id" do subitem + "_destroy=true" items: properties: description: type: string description: Descrição do item. quantity: type: integer description: Quantidade do item. format: int32 price_cents: type: integer description: 'Valor do item em centavos. Valor mínimo: 100.' format: int32 id: type: string description: ID do item, utilizado só em casos de edição ou remoção. _destroy: type: boolean description: Caso `true`, remove o item de uma fatura. ID do item é obrigatório. type: object ignore_due_email: type: boolean description: Ignora o envio do e-mail de cobrança da nova fatura. ignore_canceled_email: type: boolean description: Ignora o envio do e-mail de cancelamento da fatura atual. current_fines_option: type: boolean description: Caso `true`, aplica multas da fatura original à segunda via. keep_early_payment_discount: type: boolean description: Caso `true`, copia os descontos de pagamento antecipado da fatura original para a 2ª via. responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"D12486C8148F4660B578B490861492DF\",\n \"due_date\": \"2024-05-01\",\n \"currency\": \"BRL\",\n \"discount_cents\": null,\n \"email\": \"teste@iugu.com\",\n \"items_total_cents\": 4000,\n \"notification_url\": null,\n \"return_url\": null,\n \"status\": \"pending\",\n \"tax_cents\": null,\n \"total_cents\": 4000,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"financial_return_date\": null,\n \"payable_with\": \"pix\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2024-04-29T14:10:08-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": null,\n \"payer_email\": null,\n \"payer_cpf_cnpj\": null,\n \"payer_phone\": null,\n \"payer_phone_prefix\": null,\n \"payer_address_zip_code\": null,\n \"payer_address_street\": null,\n \"payer_address_district\": null,\n \"payer_address_city\": null,\n \"payer_address_state\": null,\n \"payer_address_number\": null,\n \"payer_address_complement\": null,\n \"payer_address_country\": null,\n \"late_payment_fine\": 1,\n \"late_payment_fine_cents\": null,\n \"split_id\": null,\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [],\n \"custom_variables\": [],\n \"logs\": [\n {\n \"id\": \"7C246E82A20F4AEC8D1DF33E91B95308\",\n \"description\": \"Email de Lembrete enviado!\",\n \"notes\": \"Lembrete enviado com sucesso para: teste@iugu.com\",\n \"created_at\": \"29/04, 14:10\"\n },\n {\n \"id\": \"981CA6B1900B4684B84AFA2B5394AE72\",\n \"description\": \"Segunda via gerada\",\n \"notes\": \"Segunda via gerada da FATURA # 2233150B95EA42AC9042F3E2DD5805D4\",\n \"created_at\": \"29/04, 14:10\"\n },\n {\n \"id\": \"99879E6ABA6A4335A98DBD192F63B8F6\",\n \"description\": \"Fatura criada com sucesso!\",\n \"notes\": \"Fatura criada!\",\n \"created_at\": \"29/04, 14:10\"\n }\n ],\n \"credit_card_transaction\": null,\n \"account_id\": \"27016E1AD888499A98994E781B6C3762\",\n \"bank_account_branch\": \"0001\",\n \"bank_account_number\": \"3693443-0\",\n \"account_name\": \"IUGU Teste Produto e Integrações\",\n \"secure_id\": \"d12486c8-148f-4660-b578-b490861492df-7c29\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/d12486c8-148f-4660-b578-b490861492df-7c29\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 40,00\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": null,\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 2,\n \"created_at\": \"29/04, 14:10\",\n \"created_at_iso\": \"2024-04-29T14:10:08-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": 1111,\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": null,\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/iugu_pix/d12486c8-148f-4660-b578-b490861492df-7c29/test/qr_code\",\n \"qrcode_text\": \"http://faturas.iugu.com/iugu_pix/d12486c8-148f-4660-b578-b490861492df-7c29/test/pay\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"DE8AF199F2444643B7064BE76107B251\",\n \"description\": \"teste\",\n \"price_cents\": 2000,\n \"quantity\": 1,\n \"created_at\": \"2024-04-29T14:10:08-03:00\",\n \"updated_at\": \"2024-04-29T14:10:08-03:00\",\n \"price\": \"R$ 20,00\"\n },\n {\n \"id\": \"E03B58EABA4243949DC0E68967B2BCBC\",\n \"description\": \"teste\",\n \"price_cents\": 2000,\n \"quantity\": 1,\n \"created_at\": \"2024-04-29T14:10:08-03:00\",\n \"updated_at\": \"2024-04-29T14:10:08-03:00\",\n \"price\": \"R$ 20,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": null\n}" schema: type: object properties: id: type: string example: D12486C8148F4660B578B490861492DF due_date: type: string example: '2024-05-01' currency: type: string example: BRL discount_cents: {} email: type: string example: teste@iugu.com items_total_cents: type: integer example: 4000 default: 0 notification_url: {} return_url: {} status: type: string example: pending tax_cents: {} total_cents: type: integer example: 4000 default: 0 total_paid_cents: type: integer example: 0 default: 0 taxes_paid_cents: {} paid_at: {} paid_cents: {} cc_emails: {} financial_return_date: {} payable_with: type: string example: pix overpaid_cents: {} ignore_due_email: {} ignore_canceled_email: {} advance_fee_cents: {} commission_cents: {} early_payment_discount: type: boolean example: false default: true order_id: {} updated_at: type: string example: '2024-04-29T14:10:08-03:00' credit_card_brand: {} credit_card_bin: {} credit_card_last_4: {} credit_card_captured_at: {} credit_card_tid: {} external_reference: {} max_installments_value: {} payer_name: {} payer_email: {} payer_cpf_cnpj: {} payer_phone: {} payer_phone_prefix: {} payer_address_zip_code: {} payer_address_street: {} payer_address_district: {} payer_address_city: {} payer_address_state: {} payer_address_number: {} payer_address_complement: {} payer_address_country: {} late_payment_fine: type: integer example: 1 default: 0 late_payment_fine_cents: {} split_id: {} external_payment_id: {} external_payment_description: {} payment_booklet_id: {} subscription_id: {} variables: type: array items: type: object properties: {} custom_variables: type: array items: type: object properties: {} logs: type: array items: type: object properties: id: type: string example: 7C246E82A20F4AEC8D1DF33E91B95308 description: type: string example: Email de Lembrete enviado! notes: type: string example: 'Lembrete enviado com sucesso para: teste@iugu.com' created_at: type: string example: 29/04, 14:10 credit_card_transaction: {} account_id: type: string example: 27016E1AD888499A98994E781B6C3762 bank_account_branch: type: string example: '0001' bank_account_number: type: string example: 3693443-0 account_name: type: string example: IUGU Teste Produto e Integrações secure_id: type: string example: d12486c8-148f-4660-b578-b490861492df-7c29 secure_url: type: string example: https://checkout.iugu.com/invoices/d12486c8-148f-4660-b578-b490861492df-7c29 customer_id: {} customer_ref: {} customer_name: {} user_id: {} total: type: string example: R$ 40,00 taxes_paid: type: string example: R$ 0,00 total_paid: type: string example: R$ 0,00 total_overpaid: type: string example: R$ 0,00 total_refunded: type: string example: R$ 0,00 commission: type: string example: R$ 0,00 fines_on_occurrence_day: type: string example: R$ 0,00 total_on_occurrence_day: type: string example: R$ 0,00 fines_on_occurrence_day_cents: type: integer example: 0 default: 0 total_on_occurrence_day_cents: type: integer example: 0 default: 0 refunded_cents: type: integer example: 0 default: 0 remaining_captured_cents: type: integer example: 0 default: 0 advance_fee: {} estimated_advance_fee: {} paid: type: string example: R$ 0,00 original_payment_id: {} double_payment_id: {} per_day_interest: type: boolean example: false default: true per_day_interest_value: {} per_day_interest_cents: type: integer example: 0 default: 0 interest: {} discount: {} duplicated_invoice_id: {} bank_slip_extra_due: type: integer example: 2 default: 0 created_at: type: string example: 29/04, 14:10 created_at_iso: type: string example: '2024-04-29T14:10:08-03:00' authorized_at: {} authorized_at_iso: {} expired_at: {} expired_at_iso: {} refunded_at: {} refunded_at_iso: {} canceled_at: {} canceled_at_iso: {} protested_at: {} protested_at_iso: {} chargeback_at: {} chargeback_at_iso: {} occurrence_date: {} refundable: {} installments: {} transaction_number: type: integer example: 1111 default: 0 payment_method: {} financial_return_dates: {} bank_slip: {} pix: type: object properties: qrcode: type: string example: https://faturas.iugu.com/iugu_pix/d12486c8-148f-4660-b578-b490861492df-7c29/test/qr_code qrcode_text: type: string example: http://faturas.iugu.com/iugu_pix/d12486c8-148f-4660-b578-b490861492df-7c29/test/pay status: type: string example: qr_code_created payer_cpf_cnpj: {} payer_name: {} end_to_end_id: {} end_to_end_refund_id: {} account_number_last_digits: {} items: type: array items: type: object properties: id: type: string example: DE8AF199F2444643B7064BE76107B251 description: type: string example: teste price_cents: type: integer example: 2000 default: 0 quantity: type: integer example: 1 default: 0 created_at: type: string example: '2024-04-29T14:10:08-03:00' updated_at: type: string example: '2024-04-29T14:10:08-03:00' price: type: string example: R$ 20,00 early_payment_discounts: type: array items: type: object properties: {} split_rules: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '404': description: '404' content: text/plain: examples: Result: value: "{\n \"errors\": \"Invoice Not Found\"\n}" schema: type: object properties: errors: type: string example: Invoice Not Found deprecated: false tags: - Invoices servers: - url: https://api.iugu.com/v1 /invoices/{id}/externally_pay: put: summary: Considerar Fatura Paga Externamente description: 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". operationId: considerar-fatura-paga-externamente parameters: - name: id in: path description: ID da fatura na iugu schema: type: string required: true requestBody: content: application/json: schema: type: object required: - external_payment_id properties: external_payment_id: type: string description: ID externo da fatura (32 caracteres no máx.) external_payment_description: type: string description: Descrição do pagamento (50 caracteres no máx.) responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"EBB161AAB22849BFA047D5F1DF55AEE9\",\n \"due_date\": \"2025-04-02\",\n \"currency\": \"BRL\",\n \"discount_cents\": 24,\n \"email\": \"email@iugu.com\",\n \"items_total_cents\": 400,\n \"notification_url\": null,\n \"return_url\": \"https://google.com\",\n \"status\": \"externally_paid\",\n \"tax_cents\": null,\n \"total_cents\": 376,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": \"2025-04-02T13:49:07-03:00\",\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"financial_return_date\": null,\n \"payable_with\": \"all\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-04-02T13:49:07-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": \"John\",\n \"payer_email\": null,\n \"payer_cpf_cnpj\": \"11343675030\",\n \"payer_phone\": \"971113024\",\n \"payer_phone_prefix\": \"11\",\n \"payer_address_zip_code\": \"13056-344\",\n \"payer_address_street\": \"Rua Antônio Nunes\",\n \"payer_address_district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"payer_address_city\": \"Campinas\",\n \"payer_address_state\": \"SP\",\n \"payer_address_number\": \"21\",\n \"payer_address_complement\": \"AP1702\",\n \"payer_address_country\": \"Brasil\",\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"external_payment_id\": \"my_id\",\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"barcode_v1\",\n \"value\": \"40197103900000003762025092000000000000200864\"\n },\n {\n \"variable\": \"barcode_version\",\n \"value\": \"1\"\n },\n {\n \"variable\": \"payer.address.city\",\n \"value\": \"Campinas\"\n },\n {\n \"variable\": \"payer.address.complement\",\n \"value\": \"AP1702\"\n },\n {\n \"variable\": \"payer.address.country\",\n \"value\": \"Brasil\"\n },\n {\n \"variable\": \"payer.address.district\",\n \"value\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\"\n },\n {\n \"variable\": \"payer.address.number\",\n \"value\": \"21\"\n },\n {\n \"variable\": \"payer.address.state\",\n \"value\": \"SP\"\n },\n {\n \"variable\": \"payer.address.street\",\n \"value\": \"Rua Antônio Nunes\"\n },\n {\n \"variable\": \"payer.address.zip_code\",\n \"value\": \"13056-344\"\n },\n {\n \"variable\": \"payer.cpf_cnpj\",\n \"value\": \"11343675030\"\n },\n {\n \"variable\": \"payer.name\",\n \"value\": \"John\"\n },\n {\n \"variable\": \"payer.phone\",\n \"value\": \"971113024\"\n },\n {\n \"variable\": \"payer.phone_prefix\",\n \"value\": \"11\"\n },\n {\n \"variable\": \"payment_data.transaction_number\",\n \"value\": \"412825250927504\"\n }\n ],\n \"custom_variables\": [\n {\n \"name\": \"Minha variável\",\n \"value\": \"DSAY312HKD312JH\"\n }\n ],\n \"logs\": [\n {\n \"id\": \"F34952A91D364C1AA2C827F62615239D\",\n \"description\": \"Email de Fatura enviado!\",\n \"notes\": \"Fatura enviada com sucesso para: email@iugu.com\",\n \"created_at\": \"02/04, 13:14\"\n },\n {\n \"id\": \"63BD254B355D49F2850667053497DEB5\",\n \"description\": \"Fatura criada com sucesso!\",\n \"notes\": \"Fatura criada!\",\n \"created_at\": \"02/04, 13:14\"\n }\n ],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": \"0001\",\n \"bank_account_number\": \"2739435-0\",\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 3,76\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": \"R$ 0,24\",\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 1,\n \"created_at\": \"02/04, 13:14\",\n \"created_at_iso\": \"2025-04-02T13:14:26-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": 412825250927504,\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": null,\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"qrcode_text\": \"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"03B951855B92410890A0EA5742636E96\",\n \"description\": \"Nome do Item\",\n \"price_cents\": 300,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 3,00\"\n },\n {\n \"id\": \"36E1C5DFFD834DB6A06B67DA76363C51\",\n \"description\": \"Nome do Item 2\",\n \"price_cents\": 100,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 1,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": [\n {\n \"id\": \"AB1B22F356464105A3C17BA18A640BA9\",\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"recipient_account_id\": \"E638DCED176240E4A510510C065FB52D\",\n \"cents\": 10,\n \"percent\": 1,\n \"credit_card_cents\": null,\n \"credit_card_percent\": null,\n \"bank_slip_cents\": null,\n \"bank_slip_percent\": null,\n \"pix_cents\": null,\n \"pix_percent\": null,\n \"permit_aggregated\": true,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"credit_card_1x_cents\": null,\n \"credit_card_2x_cents\": null,\n \"credit_card_3x_cents\": null,\n \"credit_card_4x_cents\": null,\n \"credit_card_5x_cents\": null,\n \"credit_card_6x_cents\": null,\n \"credit_card_7x_cents\": null,\n \"credit_card_8x_cents\": null,\n \"credit_card_9x_cents\": null,\n \"credit_card_10x_cents\": null,\n \"credit_card_11x_cents\": null,\n \"credit_card_12x_cents\": null,\n \"credit_card_1x_percent\": null,\n \"credit_card_2x_percent\": null,\n \"credit_card_3x_percent\": null,\n \"credit_card_4x_percent\": null,\n \"credit_card_5x_percent\": null,\n \"credit_card_6x_percent\": null,\n \"credit_card_7x_percent\": null,\n \"credit_card_8x_percent\": null,\n \"credit_card_9x_percent\": null,\n \"credit_card_10x_percent\": null,\n \"credit_card_11x_percent\": null,\n \"credit_card_12x_percent\": null,\n \"credit_card_13x_cents\": null,\n \"credit_card_14x_cents\": null,\n \"credit_card_15x_cents\": null,\n \"credit_card_16x_cents\": null,\n \"credit_card_17x_cents\": null,\n \"credit_card_18x_cents\": null,\n \"credit_card_13x_percent\": null,\n \"credit_card_14x_percent\": null,\n \"credit_card_15x_percent\": null,\n \"credit_card_16x_percent\": null,\n \"credit_card_17x_percent\": null,\n \"credit_card_18x_percent\": null\n }\n ]\n}" schema: type: object properties: id: type: string example: EBB161AAB22849BFA047D5F1DF55AEE9 due_date: type: string example: '2025-04-02' currency: type: string example: BRL discount_cents: type: integer example: 24 default: 0 email: type: string example: email@iugu.com items_total_cents: type: integer example: 400 default: 0 notification_url: {} return_url: type: string example: https://google.com status: type: string example: externally_paid tax_cents: {} total_cents: type: integer example: 376 default: 0 total_paid_cents: type: integer example: 0 default: 0 taxes_paid_cents: {} paid_at: type: string example: '2025-04-02T13:49:07-03:00' paid_cents: {} cc_emails: {} financial_return_date: {} payable_with: type: string example: all overpaid_cents: {} ignore_due_email: {} ignore_canceled_email: {} advance_fee_cents: {} commission_cents: {} early_payment_discount: type: boolean example: false default: true order_id: {} updated_at: type: string example: '2025-04-02T13:49:07-03:00' credit_card_brand: {} credit_card_bin: {} credit_card_last_4: {} credit_card_captured_at: {} credit_card_tid: {} external_reference: {} max_installments_value: {} payer_name: type: string example: John payer_email: {} payer_cpf_cnpj: type: string example: '11343675030' payer_phone: type: string example: '971113024' payer_phone_prefix: type: string example: '11' payer_address_zip_code: type: string example: 13056-344 payer_address_street: type: string example: Rua Antônio Nunes payer_address_district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) payer_address_city: type: string example: Campinas payer_address_state: type: string example: SP payer_address_number: type: string example: '21' payer_address_complement: type: string example: AP1702 payer_address_country: type: string example: Brasil late_payment_fine: type: integer example: 0 default: 0 late_payment_fine_cents: {} split_id: type: string example: 3270D0BAB8074BDE98E382340338550C external_payment_id: type: string example: my_id external_payment_description: {} payment_booklet_id: {} subscription_id: {} variables: type: array items: type: object properties: variable: type: string example: barcode_v1 value: type: string example: '40197103900000003762025092000000000000200864' custom_variables: type: array items: type: object properties: name: type: string example: Minha variável value: type: string example: DSAY312HKD312JH logs: type: array items: type: object properties: id: type: string example: F34952A91D364C1AA2C827F62615239D description: type: string example: Email de Fatura enviado! notes: type: string example: 'Fatura enviada com sucesso para: email@iugu.com' created_at: type: string example: 02/04, 13:14 credit_card_transaction: {} account_id: type: string example: 44C5DC6376804D1FA792CBCA382105C1 bank_account_branch: type: string example: '0001' bank_account_number: type: string example: 2739435-0 account_name: type: string example: Nome da Conta secure_id: type: string example: ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 secure_url: type: string example: https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 customer_id: {} customer_ref: {} customer_name: {} user_id: {} total: type: string example: R$ 3,76 taxes_paid: type: string example: R$ 0,00 total_paid: type: string example: R$ 0,00 total_overpaid: type: string example: R$ 0,00 total_refunded: type: string example: R$ 0,00 fine_cents: type: integer example: 0 default: 0 commission: type: string example: R$ 0,00 fines_on_occurrence_day: type: string example: R$ 0,00 total_on_occurrence_day: type: string example: R$ 0,00 fines_on_occurrence_day_cents: type: integer example: 0 default: 0 total_on_occurrence_day_cents: type: integer example: 0 default: 0 refunded_cents: type: integer example: 0 default: 0 remaining_captured_cents: type: integer example: 0 default: 0 advance_fee: {} estimated_advance_fee: {} paid: type: string example: R$ 0,00 original_payment_id: {} double_payment_id: {} per_day_interest: type: boolean example: false default: true per_day_interest_value: {} per_day_interest_cents: type: integer example: 0 default: 0 interest: {} discount: type: string example: R$ 0,24 duplicated_invoice_id: {} bank_slip_extra_due: type: integer example: 1 default: 0 created_at: type: string example: 02/04, 13:14 created_at_iso: type: string example: '2025-04-02T13:14:26-03:00' authorized_at: {} authorized_at_iso: {} expired_at: {} expired_at_iso: {} refunded_at: {} refunded_at_iso: {} canceled_at: {} canceled_at_iso: {} protested_at: {} protested_at_iso: {} chargeback_at: {} chargeback_at_iso: {} occurrence_date: {} refundable: {} installments: {} transaction_number: type: integer example: 412825250927504 default: 0 payment_method: {} financial_return_dates: {} bank_slip: {} pix: type: object properties: qrcode: type: string example: https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 qrcode_text: type: string example: 00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6 status: type: string example: qr_code_created payer_cpf_cnpj: {} payer_name: {} end_to_end_id: {} end_to_end_refund_id: {} account_number_last_digits: {} items: type: array items: type: object properties: id: type: string example: 03B951855B92410890A0EA5742636E96 description: type: string example: Nome do Item price_cents: type: integer example: 300 default: 0 quantity: type: integer example: 1 default: 0 created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' price: type: string example: R$ 3,00 early_payment_discounts: type: array items: type: object properties: {} split_rules: type: array items: type: object properties: id: type: string example: AB1B22F356464105A3C17BA18A640BA9 split_id: type: string example: 3270D0BAB8074BDE98E382340338550C recipient_account_id: type: string example: E638DCED176240E4A510510C065FB52D cents: type: integer example: 10 default: 0 percent: type: integer example: 1 default: 0 credit_card_cents: {} credit_card_percent: {} bank_slip_cents: {} bank_slip_percent: {} pix_cents: {} pix_percent: {} permit_aggregated: type: boolean example: true default: true created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' credit_card_1x_cents: {} credit_card_2x_cents: {} credit_card_3x_cents: {} credit_card_4x_cents: {} credit_card_5x_cents: {} credit_card_6x_cents: {} credit_card_7x_cents: {} credit_card_8x_cents: {} credit_card_9x_cents: {} credit_card_10x_cents: {} credit_card_11x_cents: {} credit_card_12x_cents: {} credit_card_1x_percent: {} credit_card_2x_percent: {} credit_card_3x_percent: {} credit_card_4x_percent: {} credit_card_5x_percent: {} credit_card_6x_percent: {} credit_card_7x_percent: {} credit_card_8x_percent: {} credit_card_9x_percent: {} credit_card_10x_percent: {} credit_card_11x_percent: {} credit_card_12x_percent: {} credit_card_13x_cents: {} credit_card_14x_cents: {} credit_card_15x_cents: {} credit_card_16x_cents: {} credit_card_17x_cents: {} credit_card_18x_cents: {} credit_card_13x_percent: {} credit_card_14x_percent: {} credit_card_15x_percent: {} credit_card_16x_percent: {} credit_card_17x_percent: {} credit_card_18x_percent: {} '400': description: '400' content: application/json: examples: Result: value: "{\n \"errors\": \"Apenas Faturas pendentes podem ser pagas externamente\"\n}" schema: oneOf: - type: object properties: errors: type: string example: Invoice Not Found - type: object properties: errors: type: object properties: external_payment_id: type: array items: type: string example: can't be blank - type: object properties: errors: type: string example: Apenas Faturas pendentes podem ser pagas externamente deprecated: false tags: - Invoices servers: - url: https://api.iugu.com/v1 /invoices/{id}/refund: post: summary: Reembolsar Fatura description: Efetua o reembolso de uma Fatura. Somente alguns meios de pagamento permitem o reembolso, como por exemplo Cartão de Crédito e Pix. Após o reembolso, a Fatura fica com o status de "reembolsada", ou "refunded". Para mais informações sobre Reembolso de faturas operationId: reembolsar-fatura parameters: - name: id in: path description: ID da Fatura schema: type: string required: true requestBody: content: application/json: schema: type: object properties: partial_value_refund_cents: type: integer description: Valor parcial a ser reembolsado (somente cartão de crédito) format: int32 responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"EBB161AAB22849BFA047D5F1DF55AEE9\",\n \"due_date\": \"2025-04-02\",\n \"currency\": \"BRL\",\n \"discount_cents\": 24,\n \"email\": \"email@iugu.com\",\n \"items_total_cents\": 400,\n \"notification_url\": null,\n \"return_url\": \"https://google.com\",\n \"status\": \"refunded\",\n \"tax_cents\": null,\n \"total_cents\": 376,\n \"total_paid_cents\": 0,\n \"taxes_paid_cents\": null,\n \"paid_at\": null,\n \"paid_cents\": null,\n \"cc_emails\": null,\n \"financial_return_date\": null,\n \"payable_with\": \"all\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": null,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-04-02T13:14:27-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": \"John\",\n \"payer_email\": null,\n \"payer_cpf_cnpj\": \"11343675030\",\n \"payer_phone\": \"971113024\",\n \"payer_phone_prefix\": \"11\",\n \"payer_address_zip_code\": \"13056-344\",\n \"payer_address_street\": \"Rua Antônio Nunes\",\n \"payer_address_district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"payer_address_city\": \"Campinas\",\n \"payer_address_state\": \"SP\",\n \"payer_address_number\": \"21\",\n \"payer_address_complement\": \"AP1702\",\n \"payer_address_country\": \"Brasil\",\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"barcode_v1\",\n \"value\": \"40197103900000003762025092000000000000200864\"\n },\n {\n \"variable\": \"barcode_version\",\n \"value\": \"1\"\n },\n {\n \"variable\": \"payer.address.city\",\n \"value\": \"Campinas\"\n },\n {\n \"variable\": \"payer.address.complement\",\n \"value\": \"AP1702\"\n },\n {\n \"variable\": \"payer.address.country\",\n \"value\": \"Brasil\"\n },\n {\n \"variable\": \"payer.address.district\",\n \"value\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\"\n },\n {\n \"variable\": \"payer.address.number\",\n \"value\": \"21\"\n },\n {\n \"variable\": \"payer.address.state\",\n \"value\": \"SP\"\n },\n {\n \"variable\": \"payer.address.street\",\n \"value\": \"Rua Antônio Nunes\"\n },\n {\n \"variable\": \"payer.address.zip_code\",\n \"value\": \"13056-344\"\n },\n {\n \"variable\": \"payer.cpf_cnpj\",\n \"value\": \"11343675030\"\n },\n {\n \"variable\": \"payer.name\",\n \"value\": \"John\"\n },\n {\n \"variable\": \"payer.phone\",\n \"value\": \"971113024\"\n },\n {\n \"variable\": \"payer.phone_prefix\",\n \"value\": \"11\"\n },\n {\n \"variable\": \"payment_data.transaction_number\",\n \"value\": \"412825250927504\"\n }\n ],\n \"custom_variables\": [\n {\n \"name\": \"Minha variável\",\n \"value\": \"DSAY312HKD312JH\"\n }\n ],\n \"logs\": [\n {\n \"id\": \"F34952A91D364C1AA2C827F62615239D\",\n \"description\": \"Email de Fatura enviado!\",\n \"notes\": \"Fatura enviada com sucesso para: email@iugu.com\",\n \"created_at\": \"02/04, 13:14\"\n },\n {\n \"id\": \"63BD254B355D49F2850667053497DEB5\",\n \"description\": \"Fatura criada com sucesso!\",\n \"notes\": \"Fatura criada!\",\n \"created_at\": \"02/04, 13:14\"\n }\n ],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": \"0001\",\n \"bank_account_number\": \"2739435-0\",\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 3,76\",\n \"taxes_paid\": \"R$ 0,00\",\n \"total_paid\": \"R$ 0,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 0,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 0,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 0,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 0,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": \"R$ 0,24\",\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 1,\n \"created_at\": \"02/04, 13:14\",\n \"created_at_iso\": \"2025-04-02T13:14:26-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": null,\n \"refundable\": null,\n \"installments\": null,\n \"transaction_number\": 412825250927504,\n \"payment_method\": null,\n \"financial_return_dates\": null,\n \"bank_slip\": {\n \"digitable_line\": \"40192025089200000000700002008647710390000000376\",\n \"barcode_data\": \"40197103900000003762025092000000000000200864\",\n \"barcode\": \"https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode\",\n \"bank_slip_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip\",\n \"bank_slip_pdf_url\": \"https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf\",\n \"bank_slip_bank\": 401,\n \"bank_slip_status\": \"pending\",\n \"bank_slip_error_code\": null,\n \"bank_slip_error_message\": null,\n \"recipient_cpf_cnpj\": \"42135294870\"\n },\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03\",\n \"qrcode_text\": \"00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6\",\n \"status\": \"qr_code_created\",\n \"payer_cpf_cnpj\": null,\n \"payer_name\": null,\n \"end_to_end_id\": null,\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": null\n },\n \"items\": [\n {\n \"id\": \"03B951855B92410890A0EA5742636E96\",\n \"description\": \"Nome do Item\",\n \"price_cents\": 300,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 3,00\"\n },\n {\n \"id\": \"36E1C5DFFD834DB6A06B67DA76363C51\",\n \"description\": \"Nome do Item 2\",\n \"price_cents\": 100,\n \"quantity\": 1,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"price\": \"R$ 1,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": [\n {\n \"id\": \"AB1B22F356464105A3C17BA18A640BA9\",\n \"split_id\": \"3270D0BAB8074BDE98E382340338550C\",\n \"recipient_account_id\": \"E638DCED176240E4A510510C065FB52D\",\n \"cents\": 10,\n \"percent\": 1,\n \"credit_card_cents\": null,\n \"credit_card_percent\": null,\n \"bank_slip_cents\": null,\n \"bank_slip_percent\": null,\n \"pix_cents\": null,\n \"pix_percent\": null,\n \"permit_aggregated\": true,\n \"created_at\": \"2025-04-02T13:14:26-03:00\",\n \"updated_at\": \"2025-04-02T13:14:26-03:00\",\n \"credit_card_1x_cents\": null,\n \"credit_card_2x_cents\": null,\n \"credit_card_3x_cents\": null,\n \"credit_card_4x_cents\": null,\n \"credit_card_5x_cents\": null,\n \"credit_card_6x_cents\": null,\n \"credit_card_7x_cents\": null,\n \"credit_card_8x_cents\": null,\n \"credit_card_9x_cents\": null,\n \"credit_card_10x_cents\": null,\n \"credit_card_11x_cents\": null,\n \"credit_card_12x_cents\": null,\n \"credit_card_1x_percent\": null,\n \"credit_card_2x_percent\": null,\n \"credit_card_3x_percent\": null,\n \"credit_card_4x_percent\": null,\n \"credit_card_5x_percent\": null,\n \"credit_card_6x_percent\": null,\n \"credit_card_7x_percent\": null,\n \"credit_card_8x_percent\": null,\n \"credit_card_9x_percent\": null,\n \"credit_card_10x_percent\": null,\n \"credit_card_11x_percent\": null,\n \"credit_card_12x_percent\": null,\n \"credit_card_13x_cents\": null,\n \"credit_card_14x_cents\": null,\n \"credit_card_15x_cents\": null,\n \"credit_card_16x_cents\": null,\n \"credit_card_17x_cents\": null,\n \"credit_card_18x_cents\": null,\n \"credit_card_13x_percent\": null,\n \"credit_card_14x_percent\": null,\n \"credit_card_15x_percent\": null,\n \"credit_card_16x_percent\": null,\n \"credit_card_17x_percent\": null,\n \"credit_card_18x_percent\": null\n }\n ]\n}" schema: type: object properties: id: type: string example: EBB161AAB22849BFA047D5F1DF55AEE9 due_date: type: string example: '2025-04-02' currency: type: string example: BRL discount_cents: type: integer example: 24 default: 0 email: type: string example: email@iugu.com items_total_cents: type: integer example: 400 default: 0 notification_url: {} return_url: type: string example: https://google.com status: type: string example: refunded tax_cents: {} total_cents: type: integer example: 376 default: 0 total_paid_cents: type: integer example: 0 default: 0 taxes_paid_cents: {} paid_at: {} paid_cents: {} cc_emails: {} financial_return_date: {} payable_with: type: string example: all overpaid_cents: {} ignore_due_email: {} ignore_canceled_email: {} advance_fee_cents: {} commission_cents: {} early_payment_discount: type: boolean example: false default: true order_id: {} updated_at: type: string example: '2025-04-02T13:14:27-03:00' credit_card_brand: {} credit_card_bin: {} credit_card_last_4: {} credit_card_captured_at: {} credit_card_tid: {} external_reference: {} max_installments_value: {} payer_name: type: string example: John payer_email: {} payer_cpf_cnpj: type: string example: '11343675030' payer_phone: type: string example: '971113024' payer_phone_prefix: type: string example: '11' payer_address_zip_code: type: string example: 13056-344 payer_address_street: type: string example: Rua Antônio Nunes payer_address_district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) payer_address_city: type: string example: Campinas payer_address_state: type: string example: SP payer_address_number: type: string example: '21' payer_address_complement: type: string example: AP1702 payer_address_country: type: string example: Brasil late_payment_fine: type: integer example: 0 default: 0 late_payment_fine_cents: {} split_id: type: string example: 3270D0BAB8074BDE98E382340338550C external_payment_id: {} external_payment_description: {} payment_booklet_id: {} subscription_id: {} variables: type: array items: type: object properties: variable: type: string example: barcode_v1 value: type: string example: '40197103900000003762025092000000000000200864' custom_variables: type: array items: type: object properties: name: type: string example: Minha variável value: type: string example: DSAY312HKD312JH logs: type: array items: type: object properties: id: type: string example: F34952A91D364C1AA2C827F62615239D description: type: string example: Email de Fatura enviado! notes: type: string example: 'Fatura enviada com sucesso para: email@iugu.com' created_at: type: string example: 02/04, 13:14 credit_card_transaction: {} account_id: type: string example: 44C5DC6376804D1FA792CBCA382105C1 bank_account_branch: type: string example: '0001' bank_account_number: type: string example: 2739435-0 account_name: type: string example: Nome da Conta secure_id: type: string example: ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 secure_url: type: string example: https://checkout.iugu.com/invoices/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 customer_id: {} customer_ref: {} customer_name: {} user_id: {} total: type: string example: R$ 3,76 taxes_paid: type: string example: R$ 0,00 total_paid: type: string example: R$ 0,00 total_overpaid: type: string example: R$ 0,00 total_refunded: type: string example: R$ 0,00 fine_cents: type: integer example: 0 default: 0 commission: type: string example: R$ 0,00 fines_on_occurrence_day: type: string example: R$ 0,00 total_on_occurrence_day: type: string example: R$ 0,00 fines_on_occurrence_day_cents: type: integer example: 0 default: 0 total_on_occurrence_day_cents: type: integer example: 0 default: 0 refunded_cents: type: integer example: 0 default: 0 remaining_captured_cents: type: integer example: 0 default: 0 advance_fee: {} estimated_advance_fee: {} paid: type: string example: R$ 0,00 original_payment_id: {} double_payment_id: {} per_day_interest: type: boolean example: false default: true per_day_interest_value: {} per_day_interest_cents: type: integer example: 0 default: 0 interest: {} discount: type: string example: R$ 0,24 duplicated_invoice_id: {} bank_slip_extra_due: type: integer example: 1 default: 0 created_at: type: string example: 02/04, 13:14 created_at_iso: type: string example: '2025-04-02T13:14:26-03:00' authorized_at: {} authorized_at_iso: {} expired_at: {} expired_at_iso: {} refunded_at: {} refunded_at_iso: {} canceled_at: {} canceled_at_iso: {} protested_at: {} protested_at_iso: {} chargeback_at: {} chargeback_at_iso: {} occurrence_date: {} refundable: {} installments: {} transaction_number: type: integer example: 412825250927504 default: 0 payment_method: {} financial_return_dates: {} bank_slip: type: object properties: digitable_line: type: string example: '40192025089200000000700002008647710390000000376' barcode_data: type: string example: '40197103900000003762025092000000000000200864' barcode: type: string example: https://api.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/barcode bank_slip_url: type: string example: https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip bank_slip_pdf_url: type: string example: https://boletos.iugu.com/v1/public/invoice/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03/bank_slip.pdf bank_slip_bank: type: integer example: 401 default: 0 bank_slip_status: type: string example: pending bank_slip_error_code: {} bank_slip_error_message: {} recipient_cpf_cnpj: type: string example: '42135294870' pix: type: object properties: qrcode: type: string example: https://faturas.iugu.com/qr_code/ebb161aa-b228-49bf-a047-d5f1df55aee9-cb03 qrcode_text: type: string example: 00020101021226890014br.gov.bcb.pix2567qr.iugu.com/public/payload/v2/cobv/EBB161AAB22849BFA047D5F1DF55AEE952040000530398654043.765802BR5924NOME DA CONTA6009SAO PAULO62070503***630405E6 status: type: string example: qr_code_created payer_cpf_cnpj: {} payer_name: {} end_to_end_id: {} end_to_end_refund_id: {} account_number_last_digits: {} items: type: array items: type: object properties: id: type: string example: 03B951855B92410890A0EA5742636E96 description: type: string example: Nome do Item price_cents: type: integer example: 300 default: 0 quantity: type: integer example: 1 default: 0 created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' price: type: string example: R$ 3,00 early_payment_discounts: type: array items: type: object properties: {} split_rules: type: array items: type: object properties: id: type: string example: AB1B22F356464105A3C17BA18A640BA9 split_id: type: string example: 3270D0BAB8074BDE98E382340338550C recipient_account_id: type: string example: E638DCED176240E4A510510C065FB52D cents: type: integer example: 10 default: 0 percent: type: integer example: 1 default: 0 credit_card_cents: {} credit_card_percent: {} bank_slip_cents: {} bank_slip_percent: {} pix_cents: {} pix_percent: {} permit_aggregated: type: boolean example: true default: true created_at: type: string example: '2025-04-02T13:14:26-03:00' updated_at: type: string example: '2025-04-02T13:14:26-03:00' credit_card_1x_cents: {} credit_card_2x_cents: {} credit_card_3x_cents: {} credit_card_4x_cents: {} credit_card_5x_cents: {} credit_card_6x_cents: {} credit_card_7x_cents: {} credit_card_8x_cents: {} credit_card_9x_cents: {} credit_card_10x_cents: {} credit_card_11x_cents: {} credit_card_12x_cents: {} credit_card_1x_percent: {} credit_card_2x_percent: {} credit_card_3x_percent: {} credit_card_4x_percent: {} credit_card_5x_percent: {} credit_card_6x_percent: {} credit_card_7x_percent: {} credit_card_8x_percent: {} credit_card_9x_percent: {} credit_card_10x_percent: {} credit_card_11x_percent: {} credit_card_12x_percent: {} credit_card_13x_cents: {} credit_card_14x_cents: {} credit_card_15x_cents: {} credit_card_16x_cents: {} credit_card_17x_cents: {} credit_card_18x_cents: {} credit_card_13x_percent: {} credit_card_14x_percent: {} credit_card_15x_percent: {} credit_card_16x_percent: {} credit_card_17x_percent: {} credit_card_18x_percent: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Invoices servers: - url: https://api.iugu.com/v1 /invoices/{id}/send_email: post: summary: Enviar Fatura por Email description: Envia a fatura iugu para o email vinculado a ela. operationId: enviar-por-email parameters: - name: id in: path description: ID da fatura. schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"AB1136DB52934C629DEE3CAC141C0C3E\",\n \"due_date\": \"2025-02-18\",\n \"currency\": \"BRL\",\n \"discount_cents\": null,\n \"email\": \"email@iug.com\",\n \"items_total_cents\": 300,\n \"notification_url\": null,\n \"return_url\": null,\n \"status\": \"paid\",\n \"tax_cents\": null,\n \"total_cents\": 300,\n \"total_paid_cents\": 300,\n \"taxes_paid_cents\": 3,\n \"paid_at\": \"2025-02-18T16:26:19-03:00\",\n \"paid_cents\": 300,\n \"cc_emails\": null,\n \"financial_return_date\": null,\n \"payable_with\": \"pix\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": 0,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-02-18T16:26:20-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": null,\n \"payer_email\": null,\n \"payer_cpf_cnpj\": null,\n \"payer_phone\": null,\n \"payer_phone_prefix\": null,\n \"payer_address_zip_code\": null,\n \"payer_address_street\": null,\n \"payer_address_district\": null,\n \"payer_address_city\": null,\n \"payer_address_state\": null,\n \"payer_address_number\": null,\n \"payer_address_complement\": null,\n \"payer_address_country\": null,\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": null,\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"payment_method\",\n \"value\": \"iugu_pix\"\n },\n {\n \"variable\": \"total_views\",\n \"value\": \"2\"\n }\n ],\n \"custom_variables\": [],\n \"logs\": [\n {\n \"id\": \"3B0FFB20DCC94F34AA2AD5607C7D521B\",\n \"description\": \"Fatura visualizada via checkout\",\n \"notes\": \"Fatura visualizada!!\",\n \"created_at\": \"02/04, 14:58\"\n },\n {\n \"id\": \"BE101B1EC8D647C7AEC59B9BEA947103\",\n \"description\": \"Email de Recibo enviado!\",\n \"notes\": \"Recibo enviado com sucesso para: email@iug.com\",\n \"created_at\": \"18/02, 16:26\"\n },\n {\n \"id\": \"9CA70A27A1BA4D6B975D8A9C9CAC1503\",\n \"description\": \"Fatura paga com sucesso!\",\n \"notes\": \"Fatura paga com Pix por: Nome do Pagador, 111.222.333 44\",\n \"created_at\": \"18/02, 16:26\"\n },\n {\n \"id\": \"177753D821294492B52BAE6D701E3A89\",\n \"description\": \"QrCode visualizado!\",\n \"notes\": \"Fatura visualizada!!\",\n \"created_at\": \"18/02, 16:26\"\n },\n {\n \"id\": \"0200F316D5984E33A866DAAB6A1E1432\",\n \"description\": \"Fatura criada com sucesso!\",\n \"notes\": \"Fatura criada!\",\n \"created_at\": \"18/02, 16:15\"\n },\n {\n \"id\": \"FB5B0151D0F5496087A08AAF56479668\",\n \"description\": \"Email de Fatura enviado!\",\n \"notes\": \"Fatura enviada com sucesso para: email@iug.com\",\n \"created_at\": \"18/02, 16:15\"\n }\n ],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": \"0001\",\n \"bank_account_number\": \"2739435-0\",\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"ab1136db-5293-4c62-9dee-3cac141c0c3e-9329\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/-5293-4c62-9dee-3cac141c0c3e-9329\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 3,00\",\n \"taxes_paid\": \"R$ 0,03\",\n \"total_paid\": \"R$ 3,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 3,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 300,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 300,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 3,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": null,\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 10,\n \"created_at\": \"18/02, 16:15\",\n \"created_at_iso\": \"2025-02-18T16:15:32-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": \"2025-02-18\",\n \"refundable\": true,\n \"installments\": null,\n \"transaction_number\": null,\n \"payment_method\": \"iugu_pix\",\n \"financial_return_dates\": null,\n \"bank_slip\": null,\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/-5293-4c62-9dee-3cac141c0c3e-9329\",\n \"qrcode_text\": \"00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/AB1136DB52934C629DEE3CAC141C0C3E52040000530398654043.005802BR5924NOME DA CONTA6009SAO PAULO62070503***6304EC4D\",\n \"status\": \"paid\",\n \"payer_cpf_cnpj\": \"11122233344\",\n \"payer_name\": \"Nome do Pagador\",\n \"end_to_end_id\": \"B245436542345231234454Ru9No0iLU\",\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": \"5132\"\n },\n \"items\": [\n {\n \"id\": \"9A989E79E6094548B10E7A356A06E7DF\",\n \"description\": \"Item\",\n \"price_cents\": 300,\n \"quantity\": 1,\n \"created_at\": \"2025-02-18T16:15:32-03:00\",\n \"updated_at\": \"2025-02-18T16:15:32-03:00\",\n \"price\": \"R$ 3,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": null\n}" schema: type: object properties: id: type: string example: AB1136DB52934C629DEE3CAC141C0C3E due_date: type: string example: '2025-02-18' currency: type: string example: BRL discount_cents: {} email: type: string example: email@iug.com items_total_cents: type: integer example: 300 default: 0 notification_url: {} return_url: {} status: type: string example: paid tax_cents: {} total_cents: type: integer example: 300 default: 0 total_paid_cents: type: integer example: 300 default: 0 taxes_paid_cents: type: integer example: 3 default: 0 paid_at: type: string example: '2025-02-18T16:26:19-03:00' paid_cents: type: integer example: 300 default: 0 cc_emails: {} financial_return_date: {} payable_with: type: string example: pix overpaid_cents: {} ignore_due_email: {} ignore_canceled_email: {} advance_fee_cents: {} commission_cents: type: integer example: 0 default: 0 early_payment_discount: type: boolean example: false default: true order_id: {} updated_at: type: string example: '2025-02-18T16:26:20-03:00' credit_card_brand: {} credit_card_bin: {} credit_card_last_4: {} credit_card_captured_at: {} credit_card_tid: {} external_reference: {} max_installments_value: {} payer_name: {} payer_email: {} payer_cpf_cnpj: {} payer_phone: {} payer_phone_prefix: {} payer_address_zip_code: {} payer_address_street: {} payer_address_district: {} payer_address_city: {} payer_address_state: {} payer_address_number: {} payer_address_complement: {} payer_address_country: {} late_payment_fine: type: integer example: 0 default: 0 late_payment_fine_cents: {} split_id: {} external_payment_id: {} external_payment_description: {} payment_booklet_id: {} subscription_id: {} variables: type: array items: type: object properties: variable: type: string example: payment_method value: type: string example: iugu_pix custom_variables: type: array items: type: object properties: {} logs: type: array items: type: object properties: id: type: string example: 3B0FFB20DCC94F34AA2AD5607C7D521B description: type: string example: Fatura visualizada via checkout notes: type: string example: Fatura visualizada!! created_at: type: string example: 02/04, 14:58 credit_card_transaction: {} account_id: type: string example: 44C5DC6376804D1FA792CBCA382105C1 bank_account_branch: type: string example: '0001' bank_account_number: type: string example: 2739435-0 account_name: type: string example: Nome da Conta secure_id: type: string example: ab1136db-5293-4c62-9dee-3cac141c0c3e-9329 secure_url: type: string example: https://checkout.iugu.com/invoices/-5293-4c62-9dee-3cac141c0c3e-9329 customer_id: {} customer_ref: {} customer_name: {} user_id: {} total: type: string example: R$ 3,00 taxes_paid: type: string example: R$ 0,03 total_paid: type: string example: R$ 3,00 total_overpaid: type: string example: R$ 0,00 total_refunded: type: string example: R$ 0,00 fine_cents: type: integer example: 0 default: 0 commission: type: string example: R$ 0,00 fines_on_occurrence_day: type: string example: R$ 0,00 total_on_occurrence_day: type: string example: R$ 3,00 fines_on_occurrence_day_cents: type: integer example: 0 default: 0 total_on_occurrence_day_cents: type: integer example: 300 default: 0 refunded_cents: type: integer example: 0 default: 0 remaining_captured_cents: type: integer example: 300 default: 0 advance_fee: {} estimated_advance_fee: {} paid: type: string example: R$ 3,00 original_payment_id: {} double_payment_id: {} per_day_interest: type: boolean example: false default: true per_day_interest_value: {} per_day_interest_cents: type: integer example: 0 default: 0 interest: {} discount: {} duplicated_invoice_id: {} bank_slip_extra_due: type: integer example: 10 default: 0 created_at: type: string example: 18/02, 16:15 created_at_iso: type: string example: '2025-02-18T16:15:32-03:00' authorized_at: {} authorized_at_iso: {} expired_at: {} expired_at_iso: {} refunded_at: {} refunded_at_iso: {} canceled_at: {} canceled_at_iso: {} protested_at: {} protested_at_iso: {} chargeback_at: {} chargeback_at_iso: {} occurrence_date: type: string example: '2025-02-18' refundable: type: boolean example: true default: true installments: {} transaction_number: {} payment_method: type: string example: iugu_pix financial_return_dates: {} bank_slip: {} pix: type: object properties: qrcode: type: string example: https://faturas.iugu.com/qr_code/-5293-4c62-9dee-3cac141c0c3e-9329 qrcode_text: type: string example: 00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/AB1136DB52934C629DEE3CAC141C0C3E52040000530398654043.005802BR5924NOME DA CONTA6009SAO PAULO62070503***6304EC4D status: type: string example: paid payer_cpf_cnpj: type: string example: '11122233344' payer_name: type: string example: Nome do Pagador end_to_end_id: type: string example: B245436542345231234454Ru9No0iLU end_to_end_refund_id: {} account_number_last_digits: type: string example: '5132' items: type: array items: type: object properties: id: type: string example: 9A989E79E6094548B10E7A356A06E7DF description: type: string example: Item price_cents: type: integer example: 300 default: 0 quantity: type: integer example: 1 default: 0 created_at: type: string example: '2025-02-18T16:15:32-03:00' updated_at: type: string example: '2025-02-18T16:15:32-03:00' price: type: string example: R$ 3,00 early_payment_discounts: type: array items: type: object properties: {} split_rules: {} '400': description: '400' content: application/json: examples: Result: value: "{\n \"errors\": \"Invoice Not Found\"\n}" schema: type: object properties: errors: type: string example: Invoice Not Found deprecated: false tags: - Invoices servers: - url: https://api.iugu.com/v1 components: securitySchemes: sec0: type: apiKey name: api_token in: query x-refined-from: - iugu-faturas-openapi.yml - iugu-tokens-e-cobran-a-direta-openapi.yml x-readme-fauxas: true x-provenance: method: searched source: https://dev.iugu.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://dev.iugu.com/reference/antecipar-recebiveis.md - https://dev.iugu.com/reference/consultar-unidade-de-recebiveis.md - https://dev.iugu.com/reference/listar-recebiveis.md - https://dev.iugu.com/reference/listar-unidade-de-recebiveis.md merge: pages: 4 deduped: 3 conflicts_kept_first: 0