---
title: "Retornando pagamentos"
url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/retornando-pagamentos"
---

> Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md

# Retornando pagamentos

`GET` `/settlements`

Operation ID: `retornando-pagamentos`

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.

## Query parameters

- `payment_date_start` (string, required) - Início da data de pagamento. Data no formato YYYY-MM-DD
- `payment_date_end` (string, required) - Fim da data de pagamento. Data no formato YYYY-MM-DD
- `liquidation_arrangement_id` (string, optional) - ID da LiquidationArrangement
- `page` (integer, int32, optional) - Número da página
- `limit` (integer, int32, optional) - Limite de itens por página. Valor máximo = 2000
- `get_ispb` (boolean, optional) - Se retorna ou não os dados de ISPB das Settlements
- `liquidation_arrangement_id` (string, optional) - ID da LiquidationArrangement para filtrar
- `settlement_id` (string, optional) - ID da Settlement para usar como base. O ID da LiquidationArrangement desta Settlement será utilizado como filtro. Sobrescreve o parâmetro liquidation_arrangement_id
- `external_engine_payment_id` (string, optional) - ID do motor de liquidação utilizado internamente
- `order` (string, optional) - Ordernar pela criação da Settlement crescente ou decrescente. String asc ou desc

## Responses

- `200` - 200
- `400` - 400

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Pagar.me v5 API (Legado)
  version: 5.0.0
servers:
  - url: https://api.stone.com.br/core/v5
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
security:
  - sec0: []
components:
  securitySchemes:
    sec0:
      type: http
      scheme: basic
```