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

# Consultar cash-in

Consulta o status atual de uma cobrança PIX gerada anteriormente.

Use o `reference_code` retornado em `POST /v1/pix/qrcode` para identificar a transação.

<Note>
  Não use polling agressivo. Confie no webhook em `postbackUrl` como fonte primária de status. Use essa rota apenas para reconciliação manual.
</Note>


## OpenAPI

````yaml POST /v1/pix/cashin/consult
openapi: 3.0.3
info:
  title: Paysure API
  version: 1.0.0
  description: |
    API REST da Paysure para integração de pagamentos PIX em produção.

    **Capacidades:**
    - Geração de cobranças PIX (cash-in) com QR Code dinâmico
    - Pagamento de chaves PIX e QR Codes (cash-out)
    - Splits configuráveis por transação (até 20 destinatários, % do bruto)
    - Webhooks idempotentes para confirmação de pagamento
    - Consulta de status de transações
    - Chave PIX estática personalizada com identificador embutido

    Todas as transações são em **centavos** (`value_cents`) e em moeda **BRL**.
  contact:
    name: Paysure Suporte
    url: https://paysure.com.br/
servers:
  - url: https://api.paysurebr.com
    description: Produção
security:
  - ClientCredentials: []
paths:
  /v1/pix/cashin/consult:
    post:
      tags:
        - Consultas
      summary: Consultar status de uma cobrança PIX (cash-in)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - reference_code
              properties:
                reference_code:
                  type: string
                  example: PSR-9c8f7a1e-...
      responses:
        '200':
          description: Status do cash-in
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashinStatus'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    CashinStatus:
      type: object
      properties:
        cashin:
          type: object
          properties:
            reference_code:
              type: string
            external_reference:
              type: string
            value_cents:
              type: integer
            status:
              type: string
              enum:
                - pending
                - paid
                - expired
                - refunded
                - failed
            payment_date:
              type: string
              format: date-time
              nullable: true
            end_to_end:
              type: string
              nullable: true
            payer_name:
              type: string
              nullable: true
            payer_document:
              type: string
              nullable: true
    Error:
      type: object
      properties:
        message:
          type: string
        ms:
          type: number
          description: Tempo de processamento da request em ms.
  responses:
    NotFound:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ClientCredentials:
      type: apiKey
      in: header
      name: ci
      description: >
        Autenticação por par client-credentials. Envie **dois headers** em toda
        requisição:


        - `ci`: client_id (público)

        - `cs`: client_secret (privado — nunca exponha no frontend)


        Gere as credenciais no painel da Paysure em **API Keys**. Você pode ter
        múltiplas chaves ativas.

````