> ## 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 Card Payment

> Consulta os detalhes de um pagamento no cartão pelo orderCode retornado na criação. Não disponível no modo sandbox (chaves ps_test_).



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/card-payments/{orderCode}
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/card-payments/{orderCode}:
    get:
      tags:
        - Cartao
      summary: Get Card Payment
      description: >-
        Consulta os detalhes de um pagamento no cartão pelo orderCode retornado
        na criação. Não disponível no modo sandbox (chaves ps_test_).
      operationId: getCardPayment
      parameters:
        - name: orderCode
          in: path
          required: true
          schema:
            type: string
          description: Código do pedido retornado na criação do pagamento.
      responses:
        '200':
          description: Detalhes do pagamento no cartão.
          content:
            application/json:
              schema:
                type: object
                properties:
                  orderCode:
                    type: string
                    description: Código único do pedido.
                  status:
                    type: string
                    enum:
                      - pending
                      - paid
                      - expired
                      - refunded
                      - failed
                    description: Status atual do pagamento.
                  amount:
                    type: number
                    description: Valor do pagamento em reais (BRL).
                  amountCents:
                    type: integer
                    description: Valor do pagamento em centavos.
                  currency:
                    type: string
                    description: Moeda do pagamento. Sempre "BRL".
                  description:
                    type: string
                    description: Descrição do pagamento.
                  checkoutUrl:
                    type:
                      - string
                      - 'null'
                    description: URL do Stripe Checkout, ou null quando não disponível.
                  customer:
                    type:
                      - object
                      - 'null'
                    description: Dados do cliente informados na criação, ou null.
                    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
                      - 'null'
                    description: String JSON com dados livres enviados na criação, ou null.
                  paidAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: >-
                      Data e hora da confirmação do pagamento, ou null se ainda
                      não pago.
                  expiresAt:
                    type: string
                    format: date-time
                    description: Data e hora de expiração da sessão de checkout.
                  createdAt:
                    type: string
                    format: date-time
                    description: Data e hora de criação do pagamento.
              example:
                orderCode: JUE7Y9MPSX
                status: paid
                amount: 49.9
                amountCents: 4990
                currency: BRL
                description: Pagamento Cartao
                checkoutUrl: null
                customer:
                  name: João Silva
                  email: joao@email.com
                  externalId: user_123
                metadata: null
                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 inválida, ausente ou revogada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            Pagamento no cartão não encontrado (também retornado ao usar chave
            de sandbox).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Card 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_).

````