> ## Documentation Index > Fetch the complete documentation index at: https://docs.beinfi.com/llms.txt > Use this file to discover all available pages before exploring further. # Criar link de pagamento > Cria um link reutilizável e revogável para este produto. Use a `url` da resposta; o link não tem pagador, e cliente e fatura (ou assinatura) nascem quando alguém paga. Exige uma versão publicada. Publicar a versão já cria o primeiro link; use esta rota para links adicionais, para links com `successUrl` / `cancelUrl`, ou para vender uma oferta com `productVersionId`. ## OpenAPI ````yaml /api-reference/openapi.pt-BR.json post /products/{productID}/payment-links openapi: 3.1.0 info: title: Infi API version: 0.0.1 description: > A API REST do Infi: catálogo, clientes, medição de uso, assinaturas, faturas, pagamentos e checkout. **Autenticação.** Envie a chave secreta em `Authorization: Bearer sk_test_…` (sandbox) ou `sk_live_…` (produção). O prefixo da chave decide o ambiente. As rotas de checkout (`/pay/*`) e `/public/*` não levam chave: rodam no navegador de quem paga. **Idempotência.** Toda requisição que altera dados exige o header `Idempotency-Key`. Uma repetição com a mesma chave devolve a resposta original em vez de executar de novo. **Valores.** Dinheiro e quantidades trafegam como texto decimal (`"150.00"`, `"0.0001"`), nunca como número de ponto flutuante. **Erros.** O corpo traz `error_code` (estável, use para decidir), `message` (para pessoas) e `tracer_id` (envie ao suporte). Erros de limite de requisições e de idempotência vêm aninhados em `error`, com `code` e `request_id`. servers: - url: https://api-sandbox.beinfi.com description: Sandbox - url: https://api.beinfi.com description: Produção security: - bearerAuth: [] tags: - name: Catálogo - name: Clientes - name: Medição de uso - name: Assinaturas - name: Faturas - name: Pagamentos - name: Checkout - name: Cupons - name: Cobrança - name: Conta - name: Webhooks - name: Conta de teste - name: Rail - name: Lojas paths: /products/{productID}/payment-links: parameters: - $ref: '#/components/parameters/ProductID' post: tags: - Catálogo summary: Criar link de pagamento description: > Cria um link reutilizável e revogável para este produto. Use a `url` da resposta; o link não tem pagador, e cliente e fatura (ou assinatura) nascem quando alguém paga. Exige uma versão publicada. Publicar a versão já cria o primeiro link; use esta rota para links adicionais, para links com `successUrl` / `cancelUrl`, ou para vender uma oferta com `productVersionId`. operationId: createPaymentLink requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreatePaymentLinkRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/PaymentLink' description: Link criado. '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '422': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: >- O produto não tem versão publicada (`errors[0].field` é `productId`): publique uma primeiro. Ou `successUrl` / `cancelUrl` não é uma URL absoluta `http(s)`. components: parameters: ProductID: name: productID in: path required: true schema: type: string format: uuid description: ID do produto. schemas: CreatePaymentLinkRequest: type: object properties: successUrl: type: - string - 'null' maxLength: 2048 description: >- Para onde o pagador vai depois de pagar, com `?status=success&invoice=…` anexado. cancelUrl: type: - string - 'null' maxLength: 2048 description: >- Oferecido ao pagador como "voltar para a loja" enquanto o checkout está aberto. productVersionId: type: - string - 'null' format: uuid description: >- Vende uma versão publicada específica em vez da padrão. É assim que um preço promocional chega ao comprador: a versão é publicada com `default: false` e só um link que a indique consegue vendê-la. Omita para vender a versão padrão. Recusado se a versão não for uma versão publicada deste produto. description: >- Opcional. Um link não precisa de configuração; envie corpo só para definir para onde o pagador vai depois, ou para vender uma oferta. As URLs precisam ser absolutas `http(s)`. PaymentLink: type: object properties: id: type: string format: uuid productId: type: string format: uuid token: type: string description: Token público do link, parte da `url`. url: type: string description: >- O endereço para mandar ao pagador. Use este valor em vez de montar a URL. productVersionId: type: - string - 'null' format: uuid description: >- A versão do produto que o link vende, fixada na criação. Publicar uma nova versão não altera o preço de um link já emitido. Quando `null`, o link vende a versão publicada mais recente no momento do pagamento. active: type: boolean description: '`false` depois de revogado.' revokedAt: type: - string - 'null' format: date-time description: Quando o link foi revogado. createdAt: type: string format: date-time successUrl: type: - string - 'null' description: >- Para onde o pagador vai depois de pagar, com `?status=success&invoice=…` anexado. cancelUrl: type: - string - 'null' description: >- Oferecido ao pagador como "voltar para a loja" enquanto o checkout está aberto; também é o destino com `?status=error` quando a cobrança expira no checkout embutido. description: >- Um link de pagamento reutilizável e revogável, ligado a um produto. Quem tem o link pode abrir o checkout; ele é feito para ser copiado e compartilhado. ValidationError: type: object required: - message - error_code - tracer_id - errors properties: message: type: string error_code: $ref: '#/components/schemas/ErrorCode' tracer_id: type: string errors: type: array items: type: object required: - field - value - constraint - description properties: field: type: string value: type: string constraint: type: string description: type: string description: >- Detalhe por campo (`field`, `description`). Sempre presente num `422`; pode vir vazio. description: >- Corpo de um `422`. Mesmo formato de `Error`, mais `errors[]` com o detalhe por campo. É ali que está a frase que diz o que corrigir (por exemplo, "product has no published version"). Error: type: object required: - message - error_code - tracer_id properties: message: type: string description: Frase legível para pessoas. error_code: $ref: '#/components/schemas/ErrorCode' description: Código estável do erro. Use-o para decidir o que fazer. tracer_id: type: string description: Identificador da requisição. Informe-o ao falar com o suporte. description: >- O corpo de erro padrão. É plano (sem o envelope `error`) e o identificador de rastreio é `tracer_id`. NotFoundError: type: object required: - message - error_code - tracer_id - resource properties: message: type: string error_code: $ref: '#/components/schemas/ErrorCode' tracer_id: type: string resource: type: string ErrorCode: type: string examples: - internal_error - validation_failed - bad_request - unauthorized - forbidden - not_found - conflict - rate_limited description: >- Código estável do erro. A lista não é fechada: além dos códigos genéricos, cada área tem os seus (`coupon_expired`, `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…). Um código que você não conhece deve ser tratado pelo status HTTP, mostrando `message`; não falhe ao ler a resposta. responses: Unauthorized: content: application/json: schema: $ref: '#/components/schemas/Error' description: Chave ausente ou inválida. NotFound: content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: Recurso não encontrado. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave secreta da conta: `Authorization: Bearer sk_test_…` ou `sk_live_…`. Use só no servidor. ````