> ## Documentation Index
> Fetch the complete documentation index at: https://docs.purincash.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Payments

> Retorna a lista de pagamentos com paginação e filtros por status e tipo, ordenada da mais recente para a mais antiga.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/payments
openapi: 3.1.0
info:
  title: PurinCash API
  version: 1.0.0
servers:
  - url: https://api.purincash.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Cartao
    description: Pagamentos no cartao de credito.
  - name: Cobrancas
    description: Cobrancas PIX avulsas com valor livre.
  - name: Entregas
    description: Conteudo entregue automaticamente apos o pagamento.
  - name: Disputas
    description: Contestacoes (MED) e envio de evidencias.
  - name: Pagamentos
    description: Pagamentos PIX e LTC vinculados ou nao a um produto.
  - name: Saques
    description: Saques em PIX, LTC e USDT.
  - name: Produtos
    description: Produtos de cobranca criados pela API.
  - name: Sandbox
    description: Simulacao de pagamentos e saldo de teste.
  - name: Splits
    description: Cobrancas divididas entre varias contas.
  - name: Loja
    description: Produtos da loja do Discord (somente leitura).
  - name: Assinaturas
    description: PIX recorrente.
  - name: Carteira
    description: Saldo, retencoes e valores a liberar.
paths:
  /v1/payments:
    get:
      tags:
        - Pagamentos
      summary: List Payments
      description: >-
        Retorna a lista de pagamentos com paginação e filtros por status e tipo,
        ordenada da mais recente para a mais antiga.
      operationId: listPayments
      parameters:
        - name: limit
          in: query
          required: false
          description: Quantidade máxima de itens por página (1 a 100). Padrão 50.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: offset
          in: query
          required: false
          description: Quantidade de itens a pular (maior ou igual a 0). Padrão 0.
          schema:
            type: integer
            minimum: 0
            default: 0
        - name: status
          in: query
          required: false
          description: Filtra pelo status do pagamento.
          schema:
            type: string
            enum:
              - pending
              - paid
              - expired
              - refunded
        - name: type
          in: query
          required: false
          description: Filtra pelo tipo do pagamento.
          schema:
            type: string
            enum:
              - one_time
              - subscription
      responses:
        '200':
          description: Lista paginada de pagamentos.
          content:
            application/json:
              schema:
                type: object
                properties:
                  payments:
                    type: array
                    description: Pagamentos encontrados (mais recentes primeiro).
                    items:
                      type: object
                      properties:
                        paymentId:
                          type: string
                          description: Identificador único do pagamento (prefixo psa_).
                        status:
                          type: string
                          enum:
                            - pending
                            - paid
                            - expired
                            - refunded
                          description: Status atual do pagamento.
                        type:
                          type: string
                          enum:
                            - one_time
                            - subscription
                          description: Tipo do pagamento.
                        environment:
                          type: string
                          enum:
                            - live
                            - sandbox
                          description: Ambiente da chave de API utilizada.
                        subscriptionId:
                          type: string
                          description: >-
                            ID da assinatura no gateway. Presente apenas quando
                            type é "subscription".
                        amountCents:
                          type: integer
                          description: Valor em centavos (BRL).
                        currency:
                          type: string
                          description: Moeda do produto vinculado (padrão BRL).
                        productName:
                          type: string
                          description: >-
                            Nome do produto vinculado (vazio em pagamentos
                            avulsos).
                        customer:
                          type: object
                          description: Dados do cliente informados na criação.
                          properties:
                            name:
                              type: string
                              description: Nome do cliente.
                            email:
                              type: string
                              description: E-mail do cliente.
                            externalId:
                              type: string
                              description: Identificador do cliente no seu sistema.
                        paidAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: >-
                            Data de confirmação do pagamento (null enquanto
                            pendente).
                        createdAt:
                          type: string
                          format: date-time
                          description: Data de criação do pagamento.
                  total:
                    type: integer
                    description: Total de pagamentos que atendem ao filtro.
                  limit:
                    type: integer
                    description: Limite aplicado na consulta.
                  offset:
                    type: integer
                    description: Offset aplicado na consulta.
              example:
                payments:
                  - paymentId: psa_a1b2c3d4...
                    status: pending
                    type: one_time
                    environment: live
                    amountCents: 4990
                    currency: BRL
                    productName: Premium Plan
                    customer:
                      name: Joao Silva
                      email: joao@email.com
                      externalId: user_123
                    paidAt: null
                    createdAt: '2026-03-18T12:00:00.000Z'
                total: 42
                limit: 50
                offset: 0
        '401':
          description: Chave de API ausente, inválida ou revogada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Invalid or revoked API key
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: >-
            Mensagem de erro legivel. Trate pelo codigo HTTP; o texto pode
            mudar.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

````