v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBLinkPagamento
Consulta os links de pagamento por nome
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 |
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. |
get/api/LinkPagamento
Query parameters
NomeContainsstring
Nome do link de pagamento, aceita consulta parcial
Startinteger
Inicio da consulta
Sizeinteger
Tamanho da consulta
Headers
Aeskeystring required
Response
Links de pagamento consultados com sucesso