---
title: "Consulta os links de pagamento por nome"
method: GET
path: "/api/LinkPagamento"
tags: ["LinkPagamento"]
---

# Consulta os links de pagamento por nome

`GET /api/LinkPagamento`

Esta endpoint oferece a funcionalidade de consultar links de pagamento por nome, permitindo que você localize links específicos com base em um termo de pesquisa. 

Esse método recebe um termo de pesquisa como parâmetro e retorna uma lista de links de pagamento que contenham o termo em seu nome.
       
### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** | 
|--|--|--|--| 
| NomeContains | Texto | Nome ou parte do nome do link de pagamento | Não |
| Start | Número |Posição do início da consulta  | Não | 
| Size | Número | Quantidade de itens retornados | 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, identificado 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 | 
| 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. |

## Query parameters

- `NomeContains` string
- `Start` integer
- `Size` integer

## Headers

- `Aeskey` string, required

## Response `200`

Links de pagamento consultados com sucesso

- BknBankCobrancasAPIModelsLinkPagamentoResponse[]
  - `Criacao` string, date-time — Data de criação do 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

## Other responses

- `500` — >Erro efetuando a consulta

---

[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)