---
updatedAt: 2026-11-10T16:26:49.000Z
agentTools:
  projectIndex: https://docs.pagaleve.com.br/llms.txt
---

# Listar parcelas

Este endpoint lista as parcelas futuras baseado nos parametros fornecido. 

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "InstallmentDto": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/InstallmentItem"
            },
            "type": "array"
          },
          "total_count": {
            "description": "Número total de itens",
            "type": "number",
            "example": 5
          }
        },
        "required": [
          "items",
          "total_count"
        ],
        "type": "object"
      },
      "InstallmentItem": {
        "properties": {
          "id": {
            "description": "Id da parcela",
            "type": "string",
            "example": "9a32aac2-dbf0-4460-b736-94a2ab18b008"
          },
          "number": {
            "description": "Número da parcela",
            "type": "number",
            "example": 1
          },
          "number_of_installments": {
            "description": "Número total de parcelas",
            "type": "number",
            "example": 4
          },
          "amount": {
            "description": "Valor da parcela",
            "type": "number",
            "example": 20000
          },
          "service_fee_amount": {
            "description": "Taxa de serviço",
            "type": "number",
            "example": 0
          },
          "commission_fee_amount": {
            "description": "Taxa de comissão",
            "type": "number",
            "example": 0
          },
          "final_amount": {
            "description": "Valor final",
            "type": "number",
            "example": 20000
          },
          "number_of_recipients": {
            "description": "Número de recebedores",
            "type": "number",
            "example": 1
          },
          "recipients": {
            "items": {
              "$ref": "#/components/schemas/InstallmentRecipientDto"
            },
            "type": "array"
          },
          "transactions": {
            "items": {
              "$ref": "#/components/schemas/InstallmentTransactionDto"
            },
            "type": "array"
          },
          "status": {
            "description": "Status da parcela",
            "enum": [
              "PENDING",
              "COMPLETED",
              "REFUNDED",
              "PARTIAL_REFUNDED"
            ],
            "type": "string",
            "example": "COMPLETED"
          },
          "due_date": {
            "description": "Data de vencimento",
            "type": "string",
            "example": "2024-01-01T12:00:00.000Z"
          },
          "expected_payment_date": {
            "description": "Data de pagamento esperada",
            "type": "string",
            "example": "2024-01-02T12:00:00.000Z"
          },
          "propagated_on": {
            "description": "Data de propagação",
            "type": "string",
            "example": "2024-01-01T12:00:01.568Z"
          },
          "merchant_id": {
            "description": "Id do comerciante",
            "type": "string",
            "example": "801bd02b-6571-467b-b943-feb934e3d043"
          },
          "checkout_id": {
            "description": "Id do pedido",
            "type": "string",
            "example": "820d7111-1f19-44bf-8087-3fda0490c46a"
          },
          "plan_id": {
            "description": "Id do plano",
            "type": "string",
            "example": "b4e7ae07-5287-4a72-a6c7-d00ebcafb3bb"
          },
          "customer": {
            "$ref": "#/components/schemas/InstallmentCustomerDto"
          },
          "order": {
            "$ref": "#/components/schemas/InstallmentOrderDto"
          },
          "timestamp": {
            "description": "Data de criação",
            "type": "string",
            "example": "2024-01-01T12:00:00.000Z"
          },
          "updated_at": {
            "description": "Data de atualização",
            "type": "string",
            "example": "2024-01-01T12:00:00.000Z"
          },
          "payment_flow": {
            "description": "Tipo do pagamento do pedido",
            "enum": [
              "D1",
              "ALL_D30",
              "MONTHLY",
              "FORTNIGHTLY",
              "DX"
            ],
            "type": "string",
            "example": "FORTNIGHTLY"
          },
          "days_to_pay": {
            "description": "Dias para pagamento (DX)",
            "type": "number",
            "example": 10
          },
          "propagated_refund_ids": {
            "description": "UUID das trasações de reembolso propagadas",
            "items": {
              "type": "string",
              "example": "53e6ebbb-6326-463f-affc-da2adad14c2f"
            },
            "type": "array"
          }
        },
        "required": [
          "id",
          "number",
          "number_of_installments",
          "amount",
          "service_fee_amount",
          "transaction_fee_amount",
          "commission_fee_amount",
          "final_amount",
          "number_of_recipients",
          "recipients",
          "transactions",
          "status",
          "due_date",
          "merchant_id",
          "checkout_id",
          "plan_id",
          "customer",
          "order",
          "timestamp",
          "updated_at"
        ],
        "type": "object"
      },
      "InstallmentRecipientDto": {
        "properties": {
          "id": {
            "description": "Id da transação",
            "type": "string",
            "example": "0547c832-f9ef-470d-b34f-689e47658aac"
          },
          "amount": {
            "description": "Total da transação",
            "type": "number",
            "example": 20000
          },
          "status": {
            "description": "Status do comerciante",
            "enum": [
              "Ativo",
              "Inativo",
              "Pendente"
            ],
            "type": "string",
            "example": "Ativo"
          },
          "service_fee_amount": {
            "description": "Total da taxa de serviço pago pelo vendedor",
            "type": "number",
            "example": 0
          },
          "transaction_fee_amount": {
            "description": "Total da taxa de transação pago pelo vendedor",
            "type": "number",
            "example": 0
          },
          "commission_fee_amount": {
            "description": "Total de comissão pago pelo vendedor",
            "type": "number",
            "example": 0
          },
          "final_amount": {
            "description": "Valor a receber já descontando as taxas",
            "type": "number",
            "example": 20000
          },
          "service_fee": {
            "description": "Taxa de serviço pago pelo vendedor",
            "type": "number",
            "example": 0
          },
          "transaction_fee": {
            "description": "Taxa de transação pago pelo vendedor",
            "type": "number",
            "example": 0
          },
          "commission_fee": {
            "description": "Valor de comissão que será pago ao marketplace em centavos.",
            "type": "number",
            "example": 0
          },
          "charge_processing_fee": {
            "description": "Indica se o lojista é responsável por pagar taxas da transação",
            "type": "boolean",
            "example": true
          },
          "chargeback_liable": {
            "description": "Indica se o lojista é responsável por pagar as taxas de reembolso",
            "type": "boolean",
            "example": true
          },
          "business_name": {
            "description": "Nome do lojista",
            "type": "string",
            "example": "Lojista exemplo"
          },
          "business_number": {
            "description": "CNPJ/CPF do lojista",
            "type": "string",
            "example": "99999999999999"
          }
        },
        "required": [
          "id",
          "amount",
          "status",
          "service_fee_amount",
          "transaction_fee_amount",
          "commission_fee_amount",
          "final_amount",
          "service_fee",
          "transaction_fee",
          "commission_fee",
          "charge_processing_fee",
          "chargeback_liable",
          "business_name"
        ],
        "type": "object"
      },
      "InstallmentTransactionDto": {
        "properties": {
          "id": {
            "description": "Id da transação",
            "type": "string",
            "example": "0547c832-f9ef-470d-b34f-689e47658aac"
          },
          "amount": {
            "description": "Total da transação",
            "type": "number",
            "example": 20000
          },
          "service_fee_amount": {
            "description": "Total da taxa de serviço pago pelo vendedor",
            "type": "number",
            "example": 0
          },
          "transaction_fee_amount": {
            "description": "Total da taxa de transação pago pelo vendedor",
            "type": "number",
            "example": 0
          },
          "commission_fee_amount": {
            "description": "Total de comissão pago pelo vendedor",
            "type": "number",
            "example": 0
          },
          "final_amount": {
            "description": "Valor a receber já descontando as taxas",
            "type": "number",
            "example": 20000
          },
          "type": {
            "description": "Tipo da transação",
            "enum": [
              "TRANSACTION",
              "REFUND_TRANSACTION"
            ],
            "type": "string",
            "example": "TRANSACTION"
          },
          "timestamp": {
            "description": "Data da criação da transação",
            "type": "string",
            "example": "2024-02-10"
          },
          "merchant_id": {
            "description": "Id do comerciante",
            "type": "string",
            "example": "82050938-9690-4d20-a870-bd6f05687f86"
          },
          "business_name": {
            "description": "Nome do lojista",
            "type": "string",
            "example": "Lojista exemplo"
          },
          "business_number": {
            "description": "CNPJ/CPF do lojista",
            "type": "string",
            "example": "99999999999999"
          }
        },
        "required": [
          "id",
          "amount",
          "service_fee_amount",
          "transaction_fee_amount",
          "commission_fee_amount",
          "final_amount",
          "type",
          "timestamp",
          "merchant_id",
          "business_name"
        ],
        "type": "object"
      },
      "InstallmentCustomerDto": {
        "properties": {
          "id": {
            "description": "Id do cliente",
            "type": "string",
            "example": "0248adab-6d4a-48ba-afc5-131a0fdba486"
          },
          "phone": {
            "description": "Número de contato",
            "type": "string",
            "example": 5548991234567
          },
          "email": {
            "description": "E-mail de contato",
            "type": "string",
            "example": "cliente@test.com.br"
          }
        },
        "required": [
          "id",
          "phone",
          "email"
        ],
        "type": "object"
      },
      "InstallmentOrderDto": {
        "properties": {
          "id": {
            "description": "Id do pedido",
            "type": "string",
            "example": "e918e1ea-a5de-42a9-bc5a-49930ddd6e00"
          },
          "purchase_date": {
            "description": "Data da compra",
            "type": "string",
            "example": "2024-02-10T00:00:00.000Z"
          },
          "amount": {
            "description": "Valor do pedido",
            "type": "number",
            "example": 20000
          },
          "reference": {
            "description": "Código de referência",
            "type": "string",
            "example": "PL20240210993468"
          },
          "payment_id": {
            "description": "Id do pagamento",
            "type": "string",
            "example": "6777cc5b-5251-44bd-85f3-c07371717103"
          }
        },
        "required": [
          "id",
          "purchase_date",
          "amount",
          "reference",
          "payment_id"
        ],
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "contact": {},
    "description": "API pública",
    "title": "API Endpoints",
    "version": "1.0"
  },
  "openapi": "3.0.0",
  "paths": {
    "/v1/future-settlements": {
      "get": {
        "description": "Este endpoint lista as parcelas futuras baseado nos parametros fornecido. ",
        "operationId": "InstallmentsController_get",
        "parameters": [
          {
            "description": "Token de autorização Bearer",
            "in": "header",
            "name": "Authorization",
            "required": true,
            "schema": {
              "type": "string",
              "example": "Bearer eyJhbGciOiJIUzI1NiJ9..."
            }
          },
          {
            "description": "Id da subsidiária que será utilizado para efetuar a operação",
            "in": "header",
            "name": "Subsidiary-Id",
            "schema": {
              "type": "string"
            },
            "example": "20f3b44f-aec4-480f-a2e7-23b9929ba6cd"
          },
          {
            "description": "Número de página para iniciar (>=0)",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Número máximo de itens a serem retornados (limitado em 200)",
            "in": "query",
            "name": "size",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Data no formato ISO (UTC-0)",
            "in": "query",
            "name": "start_date",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Data no formato ISO (UTC-0)",
            "in": "query",
            "name": "end_date",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Data no formato ISO",
            "in": "query",
            "name": "creation_start_date",
            "example": "2023-12-01T00:00:00.000Z",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Data no formato ISO",
            "in": "query",
            "name": "creation_end_date",
            "example": "2023-12-01T00:00:00.000Z",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Data no formato ISO",
            "in": "query",
            "name": "updated_start_date",
            "example": "2023-12-01T00:00:00.000Z",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Data no formato ISO",
            "in": "query",
            "name": "updated_end_date",
            "example": "2023-12-01T00:00:00.000Z",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Texto para filtrar a pesquisa",
            "in": "query",
            "name": "text_to_search",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "UUID da subsidiaria cuja parcela deseja-se obter (A mesma precisa estar associada a Holding em questão)",
            "in": "query",
            "name": "subsidiary_ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "UUID do seller cuja parcela deseja-se obter (O mesmo precisa estar associado ao Marketplace em questão)",
            "in": "query",
            "name": "seller_ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Define se serão listadas as parcelas de todas as subsidiárias ou sellers da holding ou marketplace logado",
            "in": "query",
            "name": "list_all",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "description": "UUID do pedido cuja parcela deseja-se obter",
            "in": "query",
            "name": "checkout_id",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Define o status das parcelas listadas",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "UUID das trasações de reembolso propagadas (campo transactionId de um REFUND_TRANSACTION na API de listagem de transações)",
            "in": "query",
            "name": "propagated_refund_ids",
            "example": "53e6ebbb-6326-463f-affc-da2adad14c2f",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "UUID da antecipação solicitada cuja parcela deseja-se obter",
            "in": "query",
            "name": "anticipation_request_id",
            "required": false,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "description": "Timezone da data de criação da parcela",
            "name": "timezone",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InstallmentDto"
                }
              }
            },
            "description": "OK"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Listar parcelas",
        "tags": [
          "Liquidações V1"
        ]
      }
    }
  },
  "servers": [
    {
      "description": "Staging server",
      "url": "https://sandbox-api.pagaleve.io"
    },
    {
      "description": "Production server",
      "url": "https://api.pagaleve.com.br"
    },
    {
      "url": "https://pre-analysis.pagaleve.com.br/api/v1",
      "description": "Pre-analysis production server"
    },
    {
      "url": "https://sandbox-pre-analysis.pagaleve.io/api/v1",
      "description": "Pre-analysis staging server"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```