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

# Consultar status da cobrança PIX

> Retorna apenas status e campos essenciais — recomendado para polling enquanto aguarda o pagamento.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/payment-pix/status/clx_transacao' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```
</RequestExample>

<ResponseExample>
  ```json Success — aguardando pagamento theme={null}
  {
    "success": true,
    "message": "Status do pagamento PIX consultado",
    "data": {
      "id": "clx_transacao",
      "status": "PENDING",
      "amount": 100,
      "netAmount": 99.2,
      "feeAmount": 0.8,
      "externalReference": "pedido-123",
      "endToEndId": null,
      "expiresAt": "2026-07-31T18:00:00.000Z",
      "completedAt": null,
      "createdAt": "2026-07-31T12:00:00.000Z"
    },
    "requestId": "req_abc123"
  }
  ```

  ```json Success — pago theme={null}
  {
    "success": true,
    "message": "Status do pagamento PIX consultado",
    "data": {
      "id": "clx_transacao",
      "status": "COMPLETED",
      "amount": 100,
      "netAmount": 99.2,
      "feeAmount": 0.8,
      "externalReference": "pedido-123",
      "endToEndId": "E12345678202505301234567890123456",
      "expiresAt": "2026-07-31T18:00:00.000Z",
      "completedAt": "2026-07-31T12:05:00.000Z",
      "createdAt": "2026-07-31T12:00:00.000Z"
    },
    "requestId": "req_abc123"
  }
  ```
</ResponseExample>

### Envelope da resposta

| Campo     | Tipo    | Descrição                                   |
| --------- | ------- | ------------------------------------------- |
| success   | boolean | `true` em sucesso HTTP 2xx                  |
| message   | string  | Mensagem legível                            |
| data      | object  | Status e campos essenciais (formato abaixo) |
| requestId | string  | ID da requisição para suporte (`req_...`)   |

### Status em `data.status`

| Status     | Significado              |
| ---------- | ------------------------ |
| PENDING    | Aguardando pagamento     |
| PROCESSING | Em processamento         |
| COMPLETED  | Recebido com sucesso     |
| FAILED     | Falhou                   |
| CANCELED   | Cancelado ou QR expirado |
| REVERSED   | Estorno concluído        |

### Campos em `data`

| Campo             | Descrição                        |
| ----------------- | -------------------------------- |
| id                | ID da transação                  |
| status            | Ver tabela acima                 |
| amount            | Valor bruto                      |
| netAmount         | Valor líquido                    |
| feeAmount         | Tarifa da operação               |
| externalReference | Referência enviada na criação    |
| endToEndId        | Identificador E2E após pagamento |
| expiresAt         | Expiração do QR                  |
| completedAt       | Data de conclusão                |
| createdAt         | Data de criação                  |

<Note>
  Para QR Code, copia e cola, pagador e demais detalhes, use [Consultar cobrança](/api-reference/endpoint/payment-pix/get). Em produção, prefira [webhooks](/api-reference/guides/webhooks) (`payment.paid`).
</Note>

### Parâmetros de rota

<ParamField path="id" type="string" required>
  ID da transação (`clx_...`) ou `externalReference` enviado na criação.
</ParamField>


## OpenAPI

````yaml GET /payment-pix/status/{id}
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /payment-pix/status/{id}:
    get:
      tags:
        - pix
      summary: Consultar status da cobrança PIX
      description: >
        Retorna apenas status e campos essenciais (~500 B). **Recomendado para
        polling**

        enquanto aguarda o pagamento. Para QR Code, copia e cola e demais
        detalhes,

        use `GET /payment-pix/get/{id}`. Webhooks (`payment.paid`) continuam
        sendo o ideal.
      operationId: getPaymentPixStatus
      parameters:
        - $ref: '#/components/parameters/ResourceId'
      responses:
        '200':
          $ref: '#/components/responses/PixDepositStatusSuccess'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    ResourceId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: ID do recurso (transação, cobrança, webhook, etc.)
  responses:
    PixDepositStatusSuccess:
      description: Status da cobrança PIX (payload enxuto para polling).
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
                example: true
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicPixDepositStatus'
              requestId:
                type: string
          examples:
            pending:
              summary: Aguardando pagamento
              value:
                success: true
                message: Status do pagamento PIX consultado
                data:
                  id: clx_transacao
                  status: PENDING
                  amount: 100
                  netAmount: 99.2
                  feeAmount: 0.8
                  externalReference: pedido-123
                  endToEndId: null
                  expiresAt: '2026-07-31T18:00:00.000Z'
                  completedAt: null
                  createdAt: '2026-07-31T12:00:00.000Z'
                requestId: req_abc123
            completed:
              summary: Pagamento confirmado
              value:
                success: true
                message: Status do pagamento PIX consultado
                data:
                  id: clx_transacao
                  status: COMPLETED
                  amount: 100
                  netAmount: 99.2
                  feeAmount: 0.8
                  externalReference: pedido-123
                  endToEndId: E12345678202505301234567890123456
                  expiresAt: '2026-07-31T18:00:00.000Z'
                  completedAt: '2026-07-31T12:05:00.000Z'
                  createdAt: '2026-07-31T12:00:00.000Z'
                requestId: req_abc123
    Unauthorized:
      description: Chave ausente, inválida ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: Chave sem permissão para este endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    PublicPixDepositStatus:
      type: object
      required:
        - id
        - status
        - amount
        - netAmount
        - feeAmount
        - createdAt
      properties:
        id:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - COMPLETED
            - FAILED
            - CANCELED
            - REVERSED
        amount:
          type: number
          description: Valor bruto da cobrança.
        netAmount:
          type: number
          description: Valor líquido creditado.
        feeAmount:
          type: number
          description: Tarifa da operação.
        externalReference:
          type: string
          nullable: true
        endToEndId:
          type: string
          nullable: true
          description: Identificador E2E após pagamento confirmado.
        expiresAt:
          type: string
          format: date-time
          nullable: true
        completedAt:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      required:
        - success
        - message
        - error
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Subconta inativa
        error:
          type: object
          properties:
            code:
              type: string
              example: Bad Request
            statusCode:
              type: integer
              example: 400
        requestId:
          type: string
          example: req_abc123
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````