> ## 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 sessão de checkout

> Consulta status da sessão de checkout.

<Note>
  **URL:** `GET https://api.goatpay.com.br/v1/payment-links/sessions/get/{sessionId}` · Permissão: `payment-links/sessions/get`
</Note>

<RequestExample>
  ```bash cURL theme={null}
  curl 'https://api.goatpay.com.br/v1/payment-links/sessions/get/clx_session' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```
</RequestExample>

<ResponseExample>
  ```json Pago theme={null}
  {
    "success": true,
    "message": "Sessão de checkout",
    "data": {
      "sessionId": "clx_session",
      "status": "PAID",
      "method": "CARD",
      "amount": 99.9,
      "paidAt": "2026-06-02T15:00:00.000Z",
      "externalReference": "pedido-42",
      "transactionId": "clx_tx",
      "paymentLink": {
        "id": "clx_link",
        "slug": "plano-pro",
        "publicCode": "abc12"
      }
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>

### Status da sessão

| status    | Significado          |
| --------- | -------------------- |
| `PENDING` | Aguardando pagamento |
| `PAID`    | Pagamento confirmado |
| `EXPIRED` | Sessão expirada      |
| `FAILED`  | Falha / cancelado    |

Permissão: `payment-links/sessions/get`.

Para notificação em tempo real, use o webhook [`payment_link.paid`](/api-reference/guides/webhooks#links-de-pagamento).


## OpenAPI

````yaml GET /payment-links/sessions/get/{sessionId}
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-links/sessions/get/{sessionId}:
    get:
      tags:
        - payment-links
      summary: Consultar sessão de checkout
      operationId: getPaymentLinkSession
      parameters:
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          $ref: '#/components/responses/PaymentLinkSessionSuccess'
components:
  responses:
    PaymentLinkSessionSuccess:
      description: Sessão de checkout (status do pagamento).
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                type: object
              requestId:
                type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````