openapi: 3.2.0
info:
  title: pagarme-api Settlements API
  version: '5'
servers:
- url: https://api.pagar.me/core/v5
security:
- sec0: []
tags:
- name: Settlements
paths:
  /settlements:
    get:
      summary: Retornando pagamentos
      description: Retorna um Array contendo objetos de pagamentos (settlements) de um recebedor ordenados a partir da data de criação colocando os mais recentes no topo.
      operationId: retornando-pagamentos
      parameters:
      - name: payment_date_start
        in: query
        description: Início da data de pagamento. Data no formato YYYY-MM-DD
        required: true
        schema:
          type: string
      - name: payment_date_end
        in: query
        description: Fim da data de pagamento. Data no formato YYYY-MM-DD
        required: true
        schema:
          type: string
      - name: liquidation_arrangement_id
        in: query
        description: ID da LiquidationArrangement
        schema:
          type: string
      - name: page
        in: query
        description: Número da página
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: Limite de itens por página. Valor máximo = 2000
        schema:
          type: integer
          format: int32
      - name: get_ispb
        in: query
        description: Se retorna ou não os dados de ISPB das Settlements
        schema:
          type: boolean
      - name: liquidation_arrangement_id
        in: query
        description: ID da LiquidationArrangement para filtrar
        schema:
          type: string
      - name: settlement_id
        in: query
        description: ID da Settlement para usar como base. O ID da LiquidationArrangement desta Settlement será utilizado como filtro.  Sobrescreve o parâmetro liquidation_arrangement_id
        schema:
          type: string
      - name: external_engine_payment_id
        in: query
        description: ID do motor de liquidação utilizado internamente
        schema:
          type: string
      - name: order
        in: query
        description: Ordernar pela criação da Settlement crescente ou decrescente. String asc ou desc
        schema:
          type: string
          default: desc
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Settlements
  /settlements/{settlement_id}:
    get:
      summary: Retornando um pagamento
      description: ''
      operationId: retornando-um-pagamento
      parameters:
      - name: settlement_id
        in: path
        description: ID do pagamento
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Settlements
components:
  securitySchemes:
    sec0:
      type: http
      scheme: basic
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.pagar.me/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://docs.pagar.me/reference/ativar-faturamento-manual-1.md
  - https://docs.pagar.me/reference/atualizar-code-de-recebedor.md
  - https://docs.pagar.me/reference/cancelar-assinatura-1.md
  - https://docs.pagar.me/reference/cancelar-fatura-1.md
  - https://docs.pagar.me/reference/cancelar-um-link-de-pagamento.md
  - https://docs.pagar.me/reference/create-link.md
  - https://docs.pagar.me/reference/criar-assinatura-avulsa.md
  - https://docs.pagar.me/reference/criar-assinatura-de-plano-1.md
  - https://docs.pagar.me/reference/criar-cliente-1.md
  - https://docs.pagar.me/reference/criar-fatura-1.md
  - https://docs.pagar.me/reference/criar-link-recebedor.md
  - https://docs.pagar.me/reference/criar-link.md
  - https://docs.pagar.me/reference/criar-pedido-2.md
  - https://docs.pagar.me/reference/criar-pedido-com-antifraude.md
  - https://docs.pagar.me/reference/criar-pedido-com-split-1.md
  - https://docs.pagar.me/reference/criar-pedido-multicompradores.md
  - https://docs.pagar.me/reference/criar-pedido-multimeios.md
  - https://docs.pagar.me/reference/criar-plano-1.md
  - https://docs.pagar.me/reference/criar-recebedor-1.md
  - https://docs.pagar.me/reference/criar-token-cart%C3%A3o-1.md
  - https://docs.pagar.me/reference/deletar-item.md
  - https://docs.pagar.me/reference/desativar-faturamento-manual-1.md
  - https://docs.pagar.me/reference/editar-cliente-1.md
  - https://docs.pagar.me/reference/editar-item-1.md
  - https://docs.pagar.me/reference/editar-item-do-pedido.md
  - https://docs.pagar.me/reference/editar-item.md
  - https://docs.pagar.me/reference/editar-meio-de-pagamento-da-assinatura.md
  - https://docs.pagar.me/reference/editar-metadados-da-assinatura-1.md
  - https://docs.pagar.me/reference/editar-metadados-da-fatura-1.md
  - https://docs.pagar.me/reference/editar-metadados-do-plano-1.md
  - https://docs.pagar.me/reference/editar-minimum-price-da-assinatura.md
  - https://docs.pagar.me/reference/editar-plano-1.md
  - https://docs.pagar.me/reference/editar-recebedor-1.md
  - https://docs.pagar.me/reference/enviar-webhook.md
  - https://docs.pagar.me/reference/excluir-plano-1.md
  - https://docs.pagar.me/reference/fechar-um-pedido.md
  - https://docs.pagar.me/reference/incluir-desconto-1.md
  - https://docs.pagar.me/reference/incluir-incremento-1.md
  - https://docs.pagar.me/reference/incluir-item-1.md
  - https://docs.pagar.me/reference/incluir-item-2.md
  - https://docs.pagar.me/reference/incluir-item.md
  - https://docs.pagar.me/reference/incluir-uso.md
  - https://docs.pagar.me/reference/listar-assinaturas-1.md
  - https://docs.pagar.me/reference/listar-ciclos-1.md
  - https://docs.pagar.me/reference/listar-clientes-1.md
  - https://docs.pagar.me/reference/listar-descontos-2.md
  - https://docs.pagar.me/reference/listar-faturas-1.md
  - https://docs.pagar.me/reference/listar-incrementos.md
  - https://docs.pagar.me/reference/listar-pedidos.md
  - https://docs.pagar.me/reference/listar-planos-1.md
  - https://docs.pagar.me/reference/listar-recebedores-1.md
  - https://docs.pagar.me/reference/listar-uso.md
  - https://docs.pagar.me/reference/listar-webhooks.md
  - https://docs.pagar.me/reference/obter-assinatura-1.md
  - https://docs.pagar.me/reference/obter-ciclo-1.md
  - https://docs.pagar.me/reference/obter-cliente-1.md
  - https://docs.pagar.me/reference/obter-desconto-1.md
  - https://docs.pagar.me/reference/obter-fatura-1.md
  - https://docs.pagar.me/reference/obter-incremento-1.md
  - https://docs.pagar.me/reference/obter-item-do-pedido.md
  - https://docs.pagar.me/reference/obter-link.md
  - https://docs.pagar.me/reference/obter-links.md
  - https://docs.pagar.me/reference/obter-pedido.md
  - https://docs.pagar.me/reference/obter-plano-1.md
  - https://docs.pagar.me/reference/obter-recebedor-1.md
  - https://docs.pagar.me/reference/obter-saldo.md
  - https://docs.pagar.me/reference/obter-webhook.md
  - https://docs.pagar.me/reference/remover-desconto-1.md
  - https://docs.pagar.me/reference/remover-incremento-1.md
  - https://docs.pagar.me/reference/remover-item-1.md
  - https://docs.pagar.me/reference/remover-item.md
  - https://docs.pagar.me/reference/remover-todos-os-itens.md
  - https://docs.pagar.me/reference/remover-uso.md
  - https://docs.pagar.me/reference/renovar-ciclo-1.md
  - https://docs.pagar.me/reference/retornando-pagamentos-por-recebedor.md
  - https://docs.pagar.me/reference/retornando-pagamentos.md
  - https://docs.pagar.me/reference/retornando-um-pagamento.md
  - https://docs.pagar.me/reference/retornando-urs-de-um-recebedor-v5.md
  merge:
    pages: 78
    deduped: 82
    conflicts_kept_first: 0