---
title: "Obter links de pagamento"
url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/obter-links"
---

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

# Obter links de pagamento

`GET` `/paymentlinks`

Operation ID: `obter-links`

## Query parameters

- `name` (string, optional) - Nome do link de pagamento gerado.
- `status` (string, optional) - Status do link de pagamento gerado. Possíveis status: **building**, **active**, **cancelled**, **expired**
- `created_since` (string, date, optional) - Define o filtro de data de criação do link de pagamento para busca. Formato ISO 8601.
- `created_until` (string, date, optional) - Define o filtro de data de criação do link de pagamento para busca. Formato ISO 8601.
- `page` (integer, int32, optional) - Página a ser recuperada.
- `per_page` (integer, int32, optional) - Quantidade de links de pagamento recuperados por página. Máximo 30.

## 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:
  /paymentlinks:
    get:
      summary: Obter links de pagamento
      description: ""
      operationId: obter-links
      parameters:
        - name: name
          in: query
          description: Nome do link de pagamento gerado.
          schema:
            type: string
        - name: status
          in: query
          description: "Status do link de pagamento gerado. Possíveis status:
            **building**, **active**, **cancelled**, **expired**"
          schema:
            type: string
        - name: created_since
          in: query
          description: Define o filtro de data de criação do link de pagamento para busca.
            Formato ISO 8601.
          schema:
            type: string
            format: date
        - name: created_until
          in: query
          description: Define o filtro de data de criação do link de pagamento para busca.
            Formato ISO 8601.
          schema:
            type: string
            format: date
        - name: page
          in: query
          description: Página a ser recuperada.
          schema:
            type: integer
            format: int32
        - name: per_page
          in: query
          description: Quantidade de links de pagamento recuperados por página. Máximo 30.
          schema:
            type: integer
            format: int32
      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
```