---
title: "Consulta o link de pagamento por id"
method: GET
path: "/api/LinkPagamento/{Id}"
tags: ["LinkPagamento"]
---

# Consulta o link de pagamento por id

`GET /api/LinkPagamento/{Id}`

Esta API oferece a funcionalidade de consultar links de pagamento por ID, permitindo que você visualize informações detalhadas sobre um link específico. 
Para consultar um link de pagamento por ID, você precisa utilizar o método GET. Esse método recebe o ID do link de pagamento como parâmetro e retorna um objeto com informações detalhadas sobre o link.
### Requisição 
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** | 
|--|--|--|--| 
| Id | GUID | Id do link de pagamento | Sim |<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 |

## Path parameters

- `Id` string, required

## Headers

- `Aeskey` string, required

## Response `200`

Link de pagamento consultada

- 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

- `401` — Não há permissão para acessar este link de pagamento
- `404` — Não existe o link de pagamento por Id
- `500` — Id inválido do link de pagamento ou erro carregando 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)