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

# Insere um link de pagamento

`POST /api/LinkPagamento`

## Request

- Base URL: `https://pagamentos.meuk8.com.br/CobrancasAPI`
- URL: `https://pagamentos.meuk8.com.br/CobrancasAPI/api/LinkPagamento`
- Auth: OAuth 2
  - Password
  - Token URL: `/CobrancasAPI/token` scopes: `BknBankCobrancasAPI`

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 | Identificador único 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 | Indicador se o link de pagamento está ativo | 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 pagamento | Não |  
| LinkReutilizavel | Booleano | Indicador se o link de pagamento pode ser reutilizado | Não | 
| ParcelaFixa | Booleano | Indicador se o link de pagamento possui ou não parcelamento de cartão | Não | 
| ParcelaFixaQtd | Número | Número máximo de parcelas permitido para o link de pagamento | Não <br /> 

### Resposta
| **Campo** | **Tipo** | **Descrição** | 
|--|--|--| 
| Id | GUID | Identificador único do link de pagamento | 
| Nome | Texto | Nome do link de pagamento | 
| TipoValor | Texto | Tipo do valor do link de pagamento | 
| Valor | Numérico | Valor do link de pagamento | 
| FormasPagamento | Texto | Formas de pagamento do link de pagamento| 
| Observacoes | Texto | Observações do link de pagamento | 
| Criacao | Texto | Data de criação do link de pagamento | 
| Ativo | Booleano | Indicador se o link de pagamento está ativo | 
| LayoutPaginaInicial | Texto | Layout da página inicial do link de pagamento | 
| LayoutPaginaCompra | Texto | Layout da página de compra do link de pagamento | 
| DataExpiracao | Data | Data de expiração do link de pagamento | 
| LinkReutilizavel | Booleano | Indicador se o link de pagamento pode ser reutilizado | 
| ParcelaFixa | Booleano | Indicador se o link de pagamento possui ou não parcelamento de cartão | 
| ParcelaFixaQtd | Número | Número máximo de parcelas permitido para o link de pagamento | 
| **DadosPagamento** | Objeto | Dados do pagamento, vêm sempre nulos no momento da criação |

## 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
  - `Criacao` string, date-time: Data de criação 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
  - `DadosPagamento` BknBankCobrancasAPIModelsDadosPagamentoAgregado: Modelo de Dados Agregados de Pagamento
    - `Id` string: Id da cobrança mais recentemente paga (null se nenhuma paga)
    - `Situacao` 'pendente' | 'pago' | 'atrasado': Situação geral do pagamento
    - `DataPagamento` string, date-time: Data do pagamento mais recente
    - `FormaPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta': Forma de pagamento mais recente
    - `DadosPagamento` string: Dados do pagamento mais recente
    - `NumeroCobrancas` integer: Número de cobranças vinculadas
    - `ValorPago` number, double: Valor total pago (soma de todas cobranças pagas)
    - `ValorPrincipal` number, double: Valor principal total pago
    - `ValorMultaJuros` number, double: Valor total de multas/juros
    - `NumeroPagamento` string: Número do pagamento mais recente
    - `ValorTaxas` number, double: Valor total de taxas
    - `ValorLiquido` number, double: Valor líquido total
    - `DataDisponibilizacao` string, date-time: Data de disponibilização mais recente
    - `ReembolsadoAoCliente` boolean: Indicação se algum pagamento foi reembolsado
    - `Antecipado` boolean: Indicativo se algum pagamento foi antecipado
    - `TransacaoId` string, uuid: Id da Transação mais recente
    - `CobrancaId` string, uuid: Id da Cobrança mais recente paga
    - `NumeroCobrancasPagas` integer: Número de cobranças pagas
    - `NumeroCobrancasPendentes` integer: Número de cobranças pendentes
    - `NumeroCobrancasCanceladas` integer: Número de cobranças canceladas
    - `NumeroCobrancasInadimplentes` integer: Número de cobranças inadimplentes

## Response `201`

Link de pagamento criado

- 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
  - `Criacao` string, date-time: Data de criação 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
  - `DadosPagamento` BknBankCobrancasAPIModelsDadosPagamentoAgregado: Modelo de Dados Agregados de Pagamento
    - `Id` string: Id da cobrança mais recentemente paga (null se nenhuma paga)
    - `Situacao` 'pendente' | 'pago' | 'atrasado': Situação geral do pagamento
    - `DataPagamento` string, date-time: Data do pagamento mais recente
    - `FormaPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta': Forma de pagamento mais recente
    - `DadosPagamento` string: Dados do pagamento mais recente
    - `NumeroCobrancas` integer: Número de cobranças vinculadas
    - `ValorPago` number, double: Valor total pago (soma de todas cobranças pagas)
    - `ValorPrincipal` number, double: Valor principal total pago
    - `ValorMultaJuros` number, double: Valor total de multas/juros
    - `NumeroPagamento` string: Número do pagamento mais recente
    - `ValorTaxas` number, double: Valor total de taxas
    - `ValorLiquido` number, double: Valor líquido total
    - `DataDisponibilizacao` string, date-time: Data de disponibilização mais recente
    - `ReembolsadoAoCliente` boolean: Indicação se algum pagamento foi reembolsado
    - `Antecipado` boolean: Indicativo se algum pagamento foi antecipado
    - `TransacaoId` string, uuid: Id da Transação mais recente
    - `CobrancaId` string, uuid: Id da Cobrança mais recente paga
    - `NumeroCobrancasPagas` integer: Número de cobranças pagas
    - `NumeroCobrancasPendentes` integer: Número de cobranças pendentes
    - `NumeroCobrancasCanceladas` integer: Número de cobranças canceladas
    - `NumeroCobrancasInadimplentes` integer: Número de cobranças inadimplentes

## Other responses

- `400`: Dados inválidos do link de pagamento
- `401`: Não autorizado
- `500`: Erro criando link de pagamento

---

[API](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as.md) - [All operations](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/revisions/4b96dba8717a?raw)