get
https://pagamentos.meuk8.com.br/CobrancasAPI/api/LinkPagamento
Esta API 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 | 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 |
| Id | GUID | Identificador único do Pagamento |
| Situacao | Texto | Situação do pagamento |
| DataPagamento | Data | Data do pagamento |
| FormaPagamento | Texto | Forma de pagamento |
| DadosPagamento | Texto | Dados do pagamento, ex: número do boleto ou copia e cola do pix |
| NumeroCobrancas | Número | Número de cobranças vinculadas |
| ValorPago | Numérico | Valor total pago (soma de todas cobranças pagas) |
| ValorPrincipal | Numérico | Valor principal total pago |
| ValorMultaJuros | Numérico | Valor total de multas/juros |
| NumeroPagamento | Texto | Número do pagamento mais recente |
| ValorTaxas | Numérico | Valor total das taxas associadas |
| ValorLiquido | Numérico | Valor líquido total |
| DataDisponibilizacao | Data | Data de disponibilização mais recente |
| ReembolsadoAoCliente | Booleano | Indicação se algum pagamento foi reembolsado |
| Antecipado | Booleano | Indicativo se algum pagamento foi antecipado |
| TransacaoId | GUID | Id da Transação mais recente |
| CobrancaId | GUID | Id da Cobrança mais recente paga |
| NumeroCobrancasPagas | Número | Número de cobranças pagas |
| NumeroCobrancasPendentes | Número | Número de cobranças pendentes |
| NumeroCobrancasCanceladas | Número | Número de cobranças canceladas |
| NumeroCobrancasInadimplentes | Número | Número de cobranças inadimplentes |
| -- | -- | -- |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…