---
title: "Insere um link de pagamento"
method: POST
path: "/api/LinkPagamento"
tags: ["LinkPagamento"]
---

# Insere um link de pagamento

`POST /api/LinkPagamento`

Esta API oferece a funcionalidade de criar links de pagamento, permitindo que você gere URLs únicas para receber pagamentos online de forma rápida e segura. 
Para criar um link de pagamento, você precisa utilizar o método POST. Esse método recebe um objeto JSON com as informações do link de pagamento como parâmetro e retorna o ID do link criado.<br />

### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** | 
|--|--|--|--|
| Id | GUID | Id do link de pagamento | Não | 
| Nome | Texto | Nome do link de pagamento | Sim | 
| TipoValor | Texto | Tipo do valor do link de pagamento| Não |  
| Valor | Número | Valor do link de pagamento| Não |  
| FormasPagamento | Texto | Formas de pagamento do link de pagamento | Não |  
| Observacoes | Texto | Observações do link de pagamento | Sim | 
| Ativo | Booleano | Indicativo de ativo do link de pagamento. | Não |  
| LayoutPaginaInicial | Texto | Layout da página inicial do link de pagamento. | Não |  
| LayoutPaginaCompra | Texto | Layout da página de compra do link de pagamento. | Não |  
| DataExpiracao  | Texto | Data de expiração do link de consulta da compra. | Não |  
| LinkReutilizavel | Booleano | Informa se o link de pagamento pode ser reutilizado. | Não | 
| ParcelaFixa | Booleano | Especifica se o link de pagamento possui ou não parcelamento de cartão. | Não | 
| ParcelaFixaQtd | Número | Define o número máximo de parcelas permitido para o link de pagamento. | Não <br /> 

### Resposta
| **Campo** | **Tipo** | **Descrição** | 
|--|--|--| 
| Id | GUID | Id do link de pagamento | 
| Nome | Texto | Nome do link de pagamento | 
| TipoValor | Texto | Tipo do valor do link de pagamento| 
| Valor | Número | Valor do link de pagamento | 
| FormasPagamento | Texto | Formas de pagamento do link de pagamento| 
| Criacao | Texto | Data de criação do link de pagamento | 
| Observacoes | Texto |Observações do link de pagamento  | 
| Ativo | Booleano | Retorna true ou false, para identificar do status do link de pagamento | 
|LayoutPaginaInicial| Texto | Layout da página inicial do link de pagamento| 
| LayoutPaginaCompra | Texto | Layout da página de compra do link de pagamento | 
| DataExpiracao | Texto | Data de expiração do link de consulta da compra | 
| LinkReutilizavel | Booleano | Informa se o link de pagamento pode ser reutilizado. | 
| ParcelaFixa | Booleano | Especifica se o link de pagamento possui ou não parcelamento de cartão. | 
| ParcelaFixaQtd | Número | Define o número máximo de parcelas permitido para o link de pagamento. |

## Headers

- `Aeskey` string, required

## Request body

- BknBankCobrancasAPIModelsLinkPagamento — Modelo de Link de Pagamento
  - `Id` string — Id do link de pagamento
  - `Nome` string, required — Nome do link de pagamento
  - `TipoValor` 'fixo' | 'variavel' — Tipo do valor do link de pagamento
  - `Valor` number, double — Valor do link de pagamento
  - `FormasPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta' — Formas de pagamento do link de pagamento
  - `Observacoes` string, required — Observações do link de pagamento
  - `Ativo` boolean — Indicativo de ativo do link de pagamento
  - `LayoutPaginaInicial` string — Layout da pagina inicial do link de pagamento
  - `LayoutPaginaCompra` string — Layout da pagina de compra do link de pagamento
  - `DataExpiracao` string, date-time — Data de expiracao do link de pagamento
  - `LinkReutilizavel` boolean — Indica se o Link de pagamento é reutilizável após pago
  - `ParcelaFixa` boolean — Indica se o Link de pagamento tem parcelamento diferente da configuracao geral
  - `ParcelaFixaQtd` integer — Indica qual o maximo de parcelas o Link de pagamento pode ter

## Response `200`

OK

- object

## Other responses

- `201` — Link de pagamento criada
- `400` — Dados inválidos do link de pagamento
- `500` — Erro criando link de pagamento

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/versions/14db4977f490/schema)