---
title: "Listar pagamentos"
method: GET
path: "/payments"
---

# Listar pagamentos

`GET /payments`

## Query parameters

- `offset` integer
- `limit` integer
- `status` 'APPROVED' | 'DENIED' | 'IN_ANALYSIS' | 'PENDING' | 'REFUNDED' | 'UNPAID'
- `created_at_start` string, date
- `created_at_end` string, date
- `payment_method_type` string

## Headers

- `Authorization` string, required
- `q` string

## Response `200`

200

- object
  - `result_set` object
    - `total` integer
  - `payments` object[]
    - `id` string
    - `invoice` object
      - `id` string
      - `amount` object
        - `value` integer
        - `currency` string
    - `created_at` string
    - `updated_at` string
    - `customer` object
      - `id` string
      - `name` string
      - `email` string
    - `payment_method` object
      - `type` string
      - `card` object
        - `token` string
        - `brand` string
        - `first_digits` string
        - `last_digits` string
        - `exp_month` string
        - `exp_year` string
        - `holder` object
          - `name` string
    - `status` string
    - `provider` object
      - `name` string
      - `transaction_id` string
      - `code` string
      - `message` string
    - `links` object[]
      - `rel` string
      - `href` string
      - `media` string
      - `type` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/pagbank/apis/nova-plataforma-sandbox.md) · [All operations](https://skmtc.net/pagbank/apis/nova-plataforma-sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pagbank/nova-plataforma-sandbox/versions/05e64f3006ab/schema)
