v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Extrato Consolidado

Extrato consolidado de uma conta agrupado por tipo de movimento.

<div class="magic-block-callout type-warning"> <h3><i title="Warning" class="fa fa-exclamation-circle"></i>Atenção</h3> <div class="callout-body"> <p> Esta API obriga a utilização do <code>live_api_token</code> na autenticação da chamada. Somente em modo "produção" há movimentação de saldo na conta iugu. </p> </div> </div>

<b>Tipos de movimento</b>

<ul> <li>transfer_ted: TED</li> <li>transfer_pix: Transferência Pix</li> <li>transfer_ted_revenue: Tarifa de TED</li> <li>transfer_pix_revenue: Tarifa de Transferência Pix</li> <li>invoice_return: Liquidação de Cartão</li> <li>invoice_return_revenue: Tarifa de Liquidação de Cartão</li> <li>invoice_return_advanced: Antecipação de Recebíveis</li> <li>invoice_return_advanced_revenue: Tarifa de Liquidação Antecipada</li> <li>refund: Estorno de Cartão</li> <li>pix_refund: Estorno de Pix</li> <li>pix_refund_revert: Reversão Estorno Pix</li> <li>pix: Liquidação de Pix</li> <li>pix_revenue: Tarifa de Liquidação de Pix</li> <li>bank_slip: Liquidação de Boleto</li> <li>bank_slip_return: Liquidação de Boleto Final de Semana</li> <li>bank_slip_revenue: Tarifa de Liquidação de Boleto</li> <li>account_transfer: Transferência entre Contas</li> <li>billing: Cobrança iugu</li> <li>withdraw: Saque</li> <li>start_balance: Saldo Inicial</li> <li>end_balance: Saldo Final</li> <li>chargeback: Chargeback</li> <li>receivable_unit_settlement: Liquidação Residual de Recebíveis</li> <li>account_transfer_in: Transferência entre contas (Entrada)</li> <li>account_transfer_out: Transferência entre contas (Saída)</li> <li>advance: Tarifa de Antecipação</li> <li>misc: Outros</li> <li>deposit: Depósito</li> <li>payment: Pagamento de Contas</li> </ul>
get/accounts/consolidated_statements

Query parameters

yearinteger

Ano*

monthinteger

Mês*

dayinteger

Dia* - Não traz o resultado para um dia específico, e sim a partir do dia informando no parâmetro. Exemplo: Se informa o dia "07" nesse parâmetro, a requisição vai trazer todas as entradas do dia 07 até o último dia do mês.

Response

200

Example response

{
  "consolidated_statements": [
    {
      "id": 974098447,
      "account_id": "QND6TZC2KXT5MN9I9IR44R3N3J94JBR5",
      "movement_type": "start_balance",
      "entry_date": "2024-06-25",
      "entries_count": 1,
      "total_amount": "2.59"
    }
  ]
}