> ## 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.

# Get Payment

> Consulta os detalhes de um pagamento pelo paymentId, incluindo status, método de pagamento, cliente, metadata e datas. Use para confirmar o pagamento (polling) como alternativa ao webhook do callbackUrl.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/payments/{paymentId}
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/{paymentId}:
    get:
      tags:
        - Pagamentos
      summary: Get Payment
      description: >-
        Consulta os detalhes de um pagamento pelo paymentId, incluindo status,
        método de pagamento, cliente, metadata e datas. Use para confirmar o
        pagamento (polling) como alternativa ao webhook do callbackUrl.
      operationId: getPayment
      parameters:
        - name: paymentId
          in: path
          required: true
          description: Identificador do pagamento (ex. psa_a1b2c3d4...).
          schema:
            type: string
      responses:
        '200':
          description: Detalhes do pagamento.
          content:
            application/json:
              schema:
                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.
                  paymentMethod:
                    type: string
                    enum:
                      - pix
                      - ltc
                    description: Método de pagamento ("pix" por padrão).
                  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.
                  metadata:
                    type: string
                    description: String JSON livre enviada na criação.
                  paidAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Data de confirmação do pagamento (null enquanto pendente).
                  expiresAt:
                    type: string
                    format: date-time
                    description: Data de expiração do pagamento.
                  createdAt:
                    type: string
                    format: date-time
                    description: Data de criação do pagamento.
              example:
                paymentId: psa_a1b2c3d4...
                status: paid
                type: one_time
                paymentMethod: pix
                environment: live
                amountCents: 4990
                currency: BRL
                productName: Premium Plan
                customer:
                  name: Joao Silva
                  email: joao@email.com
                  externalId: user_123
                metadata: '{}'
                paidAt: '2026-03-18T12:05:00.000Z'
                expiresAt: '2026-03-18T12:30:00.000Z'
                createdAt: '2026-03-18T12:00:00.000Z'
        '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
        '404':
          description: >-
            Pagamento não encontrado para esta conta neste ambiente
            (live/sandbox).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Payment not found
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_).

````