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

# Obter link de pagamento

> Obtém detalhes de um link de pagamento específico



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/payment-links/{id}
openapi: 3.0.3
info:
  title: Alpa Gateway API
  version: 2.30.0
  description: >-
    Documentação completa da API pública do Alpa Gateway (v2.23.0). Todas as
    rotas requerem autenticação via API Key, exceto validação de cupom, checkout
    público e checkout de assinaturas. Novidades em 2.23.0: sistema de
    assinaturas recorrentes com planos, retry automático e métricas MRR/churn;
    cart abandonment para recuperação de vendas.
  contact:
    email: suporte@usealpa.com
  license:
    name: MIT
servers:
  - url: https://alpa-sistema-api.onrender.com
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Transações
    description: Gerenciamento de transações de pagamento
  - name: Links de Pagamento
    description: Gerenciamento de links de pagamento
  - name: Produtos
    description: Gerenciamento de produtos do catálogo
  - name: Cupons
    description: Gerenciamento de cupons de desconto
  - name: Webhooks
    description: Gerenciamento de webhooks e assinaturas
  - name: Saldo
    description: Consulta de saldo e movimentações
  - name: Clientes
    description: Gerenciamento de clientes
  - name: Afiliados
    description: Marketplace de afiliados, links rastreáveis e comissões automáticas
  - name: Assinaturas
    description: Planos de assinatura recorrente, checkout público e métricas MRR/churn
  - name: Saques
    description: Solicitações de saque, saldo disponível e métodos de retirada
  - name: Antecipações
    description: Antecipação de recebíveis de transações de cartão parceladas
  - name: Indicações
    description: >-
      Programa de indicações — código de convite, estatísticas e histórico de
      recompensas
paths:
  /api/v1/payment-links/{id}:
    get:
      tags:
        - Links de Pagamento
      summary: Obter link de pagamento
      description: Obtém detalhes de um link de pagamento específico
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Detalhes do link de pagamento
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  paymentLink:
                    $ref: '#/components/schemas/PaymentLink'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - apiKeyAuth: []
components:
  schemas:
    PaymentLink:
      type: object
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
        title:
          type: string
        description:
          type: string
          nullable: true
        amount:
          type: integer
          nullable: true
          description: Valor em centavos (null se usar products)
        currency:
          type: string
          default: BRL
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
        expiresAt:
          type: string
          format: date-time
          nullable: true
        redirectUrl:
          type: string
          format: uri
          nullable: true
        settings:
          type: object
          nullable: true
        salesCount:
          type: integer
          default: 0
        timesUsed:
          type: integer
          default: 0
        metaPixelCode:
          type: string
          nullable: true
          description: Código do Meta Pixel para rastreamento
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  responses:
    Unauthorized:
      description: Não autorizado - API Key inválida ou ausente
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: API-Key
      description: >-
        Chave de API obtida através do endpoint /api/credentials. Também aceita
        formato Bearer Token: Authorization: Bearer <api_key>

````