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

> ## Agent Instructions
> Documentação oficial da sinnu, gateway de pagamento brasileiro: Pix e cartão de crédito. O índice de todas as páginas está em https://docs.sinnu.com.br/llms.txt.
> A API (https://api.sinnu.com.br) e o checkout (https://pay.sinnu.com.br) documentados são de produção. Não há ambiente público de testes: cada chamada cria ou altera dados reais.
> A chave secreta sk_live_ fica só no servidor. O navegador recebe apenas o slug do link ou a URL do checkout.
> Unidades: amountCents do link e os valores de /api/transactions/ estão em centavos (inteiro). data.amount do webhook e amount das transações de um link estão em reais. Compare na mesma unidade.
> Status: a API de transações usa approved; o corpo do webhook usa paid; o evento é transaction.approved.
> Libere o pedido só pelo webhook assinado (X-Sinnu-Signature, validado sobre o corpo cru com constructEvent({ payload, signature, secret })) e confirme com transactions.get. Nunca pelo evento completed do Sinnu Elements nem pelos parâmetros da URL de retorno.
> Estorno é sempre do valor total. Não invente métodos, campos ou eventos: confira na referência do SDK e da API.

# Liste links de pagamento

> Consulte os links da empresa com paginação.

Use `page` e `pageSize`. No SDK, a operação corresponde a `sinnu.links.list()`.


## OpenAPI

````yaml GET /api/payment-links
openapi: 3.0.3
info:
  title: sinnu API
  version: 1.0.0
  description: >-
    API pública da sinnu para links, clientes e transações. Autentique com
    Bearer e a chave da empresa. Links usam amountCents em centavos; a API de
    transações usa centavos; webhooks e transações de um link usam reais.
    Consulte a unidade de cada recurso.
  x-source-sha256: 153c3fdb10dbb3d93407364e1d121b9565747a56c1b8db9ace49edcb2ef48d8a
servers:
  - url: https://api.sinnu.com.br
    description: Produção
security:
  - bearerAuth: []
paths:
  /api/payment-links:
    get:
      tags:
        - payment-links
      summary: Listar links de pagamento
      description: >-
        Lista os links de pagamento da empresa autenticada no envelope paginado
        do sinnu `{ data, total, page, pageSize }`.
      operationId: paymentLinks_list
      parameters:
        - in: query
          name: createdAt__gte
          schema:
            type: string
            format: date
          description: Criados a partir desta data (YYYY-MM-DD, inclusive).
        - in: query
          name: createdAt__lte
          schema:
            type: string
            format: date
          description: Criados até esta data (YYYY-MM-DD, inclusive).
        - in: query
          name: methods
          schema:
            type: string
          description: >-
            Filtra por método aceito (CSV): pix | credit_card | applepay |
            googlepay.
        - in: query
          name: ordering
          schema:
            type: string
          description: >-
            Ordenação (default -createdAt): title | status | priceMode |
            amountCents | createdAt | updatedAt, com "-" para descendente.
        - in: query
          name: page
          schema:
            type: integer
        - in: query
          name: pageSize
          schema:
            type: integer
        - in: query
          name: priceMode
          schema:
            type: string
          description: 'Filtra por modo de preço (CSV): fixed | customer_chooses.'
        - in: query
          name: search
          schema:
            type: string
          description: Busca por título, slug ou descrição do link.
        - in: query
          name: status
          schema:
            type: string
          description: >-
            Filtra por status (CSV): active | paused | archived. OMITIDO =
            catálogo (exclui os arquivados); peça `archived` para vê-los.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPaymentLink'
          description: ''
        '403':
          description: Sua chave de API não tem permissão para consultar este recurso.
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --fail-with-body --request GET \
              'https://api.sinnu.com.br/api/payment-links' \
              --header "Authorization: Bearer $SINNU_API_KEY"
        - lang: javascript
          label: JavaScript · servidor
          source: >-
            const apiKey = process.env.SINNU_API_KEY;

            if (!apiKey) throw new Error("Configure SINNU_API_KEY no
            servidor.");

            const response = await
            fetch("https://api.sinnu.com.br/api/payment-links", {
              method: "GET",
              headers: {
                Authorization: `Bearer ${apiKey}`,
              },
            });

            if (!response.ok) throw new Error(`HTTP ${response.status}: ${await
            response.text()}`);

            console.log(response.status === 204 ? null : await response.json());
components:
  schemas:
    PaginatedPaymentLink:
      type: object
      properties:
        total:
          type: integer
        page:
          type: integer
        pageSize:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/PaymentLinkRead'
        counts:
          $ref: '#/components/schemas/PaymentLinkCounts'
      required:
        - counts
        - data
        - page
        - pageSize
        - total
      example:
        data:
          - id: 00000000-0000-4000-8000-000000000003
            slug: Exemplo1
            title: Consultoria inicial
            priceMode: fixed
            amountCents: 9900
            methods:
              - pix
              - credit_card
            maxInstallments: 1
            description: Sessão de consultoria
            imageUrl: null
            minAmountCents: null
            maxAmountCents: null
            maxPayments: null
            interestMode: absorb
            status: active
            threeDsMode: always
            tags: []
            redirectUrl: null
            linkedCustomerId: null
            companyId: null
            companyName: Empresa de exemplo
            sellerEmail: vendedor@example.com
            createdAt: '2026-09-01T12:00:00.000Z'
            updatedAt: '2026-09-01T12:00:00.000Z'
        total: 1
        page: 1
        pageSize: 20
    PaymentLinkRead:
      type: object
      description: >-
        Link de pagamento público da empresa autenticada. Use o `slug` para
        montar a URL do checkout hospedado.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        slug:
          type: string
          readOnly: true
        title:
          type: string
          readOnly: true
          description: Título exibido no checkout hospedado.
        description:
          type: string
          readOnly: true
          description: Descrição exibida no checkout.
        imageUrl:
          type: string
          format: uri
          readOnly: true
          nullable: true
        priceMode:
          allOf:
            - $ref: '#/components/schemas/PriceModeEnum'
          readOnly: true
          description: Modo de preço. No contrato público atual, use sempre `fixed`.
        amountCents:
          type: integer
          readOnly: true
          nullable: true
          minimum: 1000
          maximum: 20000000
          description: 'Valor fixo do link em centavos. Obrigatório para `priceMode: fixed`.'
        minAmountCents:
          type: integer
          readOnly: true
          nullable: true
          description: >-
            Reservado para modos de preço futuros. Não use no contrato público
            atual.
        maxAmountCents:
          type: integer
          readOnly: true
          nullable: true
          description: >-
            Reservado para modos de preço futuros. Não use no contrato público
            atual.
        methods:
          type: array
          items:
            type: string
            enum:
              - pix
              - credit_card
          readOnly: true
          description: Métodos aceitos no checkout. Envie `pix`, `credit_card` ou ambos.
        maxInstallments:
          type: integer
          readOnly: true
          minimum: 1
          maximum: 12
          description: >-
            Número máximo de parcelas para cartão. Use 1 quando o link aceitar
            apenas Pix.
        interestMode:
          allOf:
            - $ref: '#/components/schemas/InterestModeEnum'
          readOnly: true
          description: >-
            Define quem absorve juros de parcelamento: `absorb` ou
            `pass_to_customer`.
        acceptsOneTime:
          type: boolean
          readOnly: true
        status:
          allOf:
            - $ref: '#/components/schemas/Status50eEnum'
          readOnly: true
          description: 'Status do link: active, paused ou archived.'
        threeDsMode:
          allOf:
            - $ref: '#/components/schemas/ThreeDsModeEnum'
          readOnly: true
          description: 'Modo de 3DS para cartão: `always` ou `contingency`.'
        tags:
          readOnly: true
          type: array
          items:
            type: string
          description: Tags livres para organização interna do link.
        redirectUrl:
          type: string
          readOnly: true
          nullable: true
          description: >-
            Para onde o checkout leva o comprador depois do pagamento confirmado
            (cartão aprovado ou Pix pago), com `transactionId`, `reference` e
            `status=approved` na query. Aceita `https://` ou o esquema do seu
            app (`meuapp://pedido`). O retorno é liberado por empresa: confirme
            com a Sinnu se já está ativo para a sua. Confirme o pagamento pela
            API ou pelo webhook: os parâmetros da URL podem ser alterados pelo
            comprador.
        externalReference:
          type: string
          readOnly: true
          nullable: true
          description: >-
            Código do produto no seu sistema. Volta como `externalRef` do item
            em cada venda do link.
        linkedCustomerId:
          type: string
          nullable: true
          readOnly: true
          description: ID do cliente vinculado ao link, quando houver.
        maxPayments:
          type: integer
          readOnly: true
          nullable: true
          description: >-
            Limite máximo de pagamentos aprovados aceitos pelo link (`null` =
            ilimitado; `1` = link de uso único que arquiva automaticamente após
            ser pago).
          minimum: 1
          maximum: 1000000
        companyId:
          type: integer
          nullable: true
          readOnly: true
        companyName:
          type: string
          nullable: true
          readOnly: true
        sellerEmail:
          type: string
          nullable: true
          readOnly: true
        salesCount:
          type: integer
          description: >-
            Nº de vendas pagas do link (Payment status='paid', alinhado a
            maxPayments).
          readOnly: true
        views:
          type: integer
          description: Visitas ao checkout público (LinkVisit, já deduplicadas na escrita).
          readOnly: true
        conversionRate:
          type: number
          format: double
          description: >-
            Fração 0..1 = salesCount/views, com guarda de divisão por zero e
            teto em 1.0.
          readOnly: true
        activeSubscriptions:
          type: integer
          description: >-
            Assinaturas deste link que CONTINUAM sendo cobradas.


            A cláusula é a de `checkout.services.still_charging_filter` - fonte

            única, para esta contagem e a da mensagem de arquivamento nunca
            contarem

            coisas diferentes.


            Serve à tela de EDIÇÃO: o aviso de que mudar o preço não repreça
            quem já

            assinou existia, bem escrito, na tela de CRIAÇÃO - onde ainda não há

            assinante e a frase não significa nada. Com o número, ele passa a

            significar.
          readOnly: true
        salespersonId:
          type: integer
          nullable: true
          readOnly: true
        salesperson:
          allOf:
            - $ref: '#/components/schemas/SaleSalesperson'
          nullable: true
          readOnly: true
        trackingPixelIds:
          type: array
          items:
            type: string
          readOnly: true
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
      required:
        - acceptsOneTime
        - activeSubscriptions
        - amountCents
        - companyId
        - companyName
        - conversionRate
        - createdAt
        - description
        - externalReference
        - id
        - imageUrl
        - interestMode
        - linkedCustomerId
        - maxAmountCents
        - maxInstallments
        - maxPayments
        - methods
        - minAmountCents
        - priceMode
        - redirectUrl
        - salesCount
        - salesperson
        - salespersonId
        - sellerEmail
        - slug
        - status
        - tags
        - threeDsMode
        - title
        - trackingPixelIds
        - updatedAt
        - views
      example:
        id: 00000000-0000-4000-8000-000000000003
        slug: Exemplo1
        title: Consultoria inicial
        priceMode: fixed
        amountCents: 9900
        methods:
          - pix
          - credit_card
        maxInstallments: 1
        description: Sessão de consultoria
        imageUrl: null
        minAmountCents: null
        maxAmountCents: null
        maxPayments: null
        interestMode: absorb
        status: active
        threeDsMode: always
        tags: []
        redirectUrl: null
        linkedCustomerId: null
        companyId: null
        companyName: Empresa de exemplo
        sellerEmail: vendedor@example.com
        createdAt: '2026-09-01T12:00:00.000Z'
        updatedAt: '2026-09-01T12:00:00.000Z'
    PaymentLinkCounts:
      type: object
      description: >-
        Contagem por status do conjunto EM ESCOPO (a empresa inteira).


        Independe da página e dos filtros da tela - é o que alimenta os KPIs

        "Links ativos" / "Total de links" do painel sem que eles contem apenas
        os

        itens da página carregada.
      properties:
        total:
          type: integer
        active:
          type: integer
        paused:
          type: integer
        archived:
          type: integer
      required:
        - active
        - archived
        - paused
        - total
    PriceModeEnum:
      enum:
        - fixed
      type: string
      description: '* `fixed` - Fixo'
    InterestModeEnum:
      enum:
        - absorb
        - pass_to_customer
      type: string
      description: |-
        * `absorb` - Eu absorvo
        * `pass_to_customer` - Cliente paga
    Status50eEnum:
      enum:
        - active
        - paused
        - archived
      type: string
      description: |-
        * `active` - Ativo
        * `paused` - Pausado
        * `archived` - Arquivado
    ThreeDsModeEnum:
      enum:
        - always
        - contingency
      type: string
      description: |-
        * `always` - Sempre
        * `contingency` - Contingência
    SaleSalesperson:
      type: object
      properties:
        id:
          type: integer
          description: ID do membro da equipe.
        name:
          type: string
        email:
          type: string
          format: email
      required:
        - email
        - id
        - name
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave secreta sk_live_ da empresa. Use somente no servidor.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.