LinkPagamento
Consulta os links de pagamento por nome
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 |
| -- | -- | -- |
get/api/LinkPagamento
Request
- Base URLhttps://pagamentos.meuk8.com.br/CobrancasAPI
- URLhttps://pagamentos.meuk8.com.br/CobrancasAPI/api/LinkPagamento
- AuthOAuth 2PasswordToken URL: /CobrancasAPI/token scopes: BknBankCobrancasAPI
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
Example response
[
{
"Id": "d162fab3-9083-45ce-a232-b9236d6c740a",
"Nome": "Link de pagamento exemplo",
"TipoValor": "fixo",
"Valor": 10.35,
"FormasPagamento": "Pix",
"Observacoes": "Descreva algo sobre o pagamento neste campo",
"Criacao": "0001-01-01T00:00:00",
"Ativo": false,
"LayoutPaginaInicial": "<!DOCTYPE html>\r\n<html lang=\"en\">\r\n<head>\r\n <meta charset=\"UTF-8\">\r\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">\r\n <meta name=\"description\" content=\"Booster is a bootstrap & laravel admin dashboard template\">\r\n <meta name=\"keywords\" content=\"admin, admin dashboard, admin panel, admin template, admin theme, bootstrap 4, laravel, crm, analytics, responsive, sass support, ui kits, web app, clean design, creative\">\r\n <meta name=\"author\" content=\"Themesbox17\">\r\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0, user-scalable=0, minimal-ui\">\r\n\r\n <title>MeuK8 Cobranças - Link</title>\r\n\r\n <!-- Fevicon -->\r\n <link rel=\"shortcut icon\" href=\"assets/images/favicon.ico\">\r\n\r\n <!-- Start CSS -->\r\n <link href=\"assets/css/bootstrap.min.css\" rel=\"stylesheet\" type=\"text/css\">\r\n <link href=\"assets/css/icons.css\" rel=\"stylesheet\" type=\"text/css\">\r\n <link href=\"assets/css/style.css\" rel=\"stylesheet\" type=\"text/css\">\r\n <!-- End CSS -->\r\n\r\n</head>\r\n<body>\r\n <%=START_FORM%>\r\n <div>\r\n <!-- Start XP Breadcrumbbar -->\r\n <div class=\"xp-breadcrumbbar text-center\">\r\n <h8 class=\"page-title px-4\">Link de Pagamento</h8>\r\n <a href=\"login\" class=\"xp-web-logo\"><img src=\"assets/images/logoCheckout.png\" height=\"50\" alt=\"logo\"></a>\r\n </div>\r\n <!-- End XP Breadcrumbbar -->\r\n <!-- Start XP Contentbar -->\r\n <div class=\"xp-contentbar\">\r\n <div class=\"row\">\r\n <!-- Start XP Col -->\r\n <div class=\"col-md-12 col-lg-12 col-xl-12\">\r\n <div class=\"row\">\r\n <div class=\"col-sm\">\r\n <a href=\"#\" class=\"pull-right xp-web-logo\"><%=LOGO%></a>\r\n </div>\r\n <div id=\"cabecalhoHTML\" class=\"pull-left col-sm\"><%=CABECALHO%></div>\r\n </div>\r\n </div>\r\n <!-- End XP Col -->\r\n <!-- Start XP Col -->\r\n <div class=\"col-md-12 col-lg-12 col-xl-12\">\r\n <div class=\"card m-b-30\">\r\n <div class=\"card-body\">\r\n <div class=\"xp-invoice\">\r\n <div class=\"row mb-3\">\r\n <div class=\"col-sm-6 col-md-6 col-lg-6\">\r\n <div class=\"xp-invoice-address mb-4\">\r\n <p class=\"f-w-5 text-black\">Dados do Produto:</p>\r\n <h6><%=NOME_LINK%></h6>\r\n <p><%=VALOR_LINK%></p>\r\n <p><%=OBSERVACOES_LINK%></p>\r\n </div>\r\n </div>\r\n <div class=\"col-sm-6 col-md-6 col-lg-6\">\r\n <div class=\"xp-invoice-address mb-4\">\r\n <p class=\"f-w-5 text-black\"><%=IMAGEM_LINK%></p>\r\n </div>\r\n </div>\r\n </div>\r\n <div id=\"divSelectPayment\" class=\"row mb-3\">\r\n <div class=\"col-md-12 col-lg-12 text-center\">\r\n <div class=\"row pb-5\">\r\n <h6 class=\"col-md-12 col-lg-12 f-w-5 text-black\">Selecione a forma de Pagamento:</h6>\r\n </div>\r\n <div class=\"row\">\r\n <div id=\"checkBoleto\" class=\"col-sm\">\r\n <input value=\"Boleto\" name=\"rdFormaPagamento\" type=\"radio\" id=\"rdBoleto\" class=\"form-check-input\" />\r\n <label class=\"form-check-label\" for=\"rdBoleto\">\r\n <img src=\"assets/images/LogoBoleto.png\" />\r\n <h6>Boleto Bancário</h6>\r\n </label>\r\n </div>\r\n <div id=\"checkCartao\" class=\"col-sm\">\r\n <input value=\"Cartão de Crédito\" name=\"rdFormaPagamento\" type=\"radio\" id=\"rdCartao\" class=\"form-check-input\" />\r\n <label class=\"form-check-label\" for=\"rdCartao\">\r\n <img src=\"assets/images/LogoCartao.png\" />\r\n <h6>Cartão de Crédito</h6>\r\n </label>\r\n </div>\r\n <div id=\"checkPix\" class=\"col-sm\">\r\n <input value=\"Pix\" name=\"rdFormaPagamento\" type=\"radio\" id=\"rdPix\" class=\"form-check-input\" />\r\n <label class=\"form-check-label\" for=\"rdPix\">\r\n <img src=\"assets/images/LogoPix.png\" />\r\n <h6>Pix</h6>\r\n </label>\r\n </div>\r\n </div>\r\n </div>\r\n </div>\r\n <div class=\"row mb-3\">\r\n\r\n <div class=\"col-md-12 col-lg-12\">\r\n <div class=\"xp-invoice-total text-right font-16\">\r\n <p>Valor Total : <span class=\"text-black f-w-5 text-success font-24\"><span id=\"lblValorTotal\"><%=VALOR_LINK%></span></span></p>\r\n </div>\r\n </div>\r\n </div>\r\n <div id=\"divMain\" class=\"row mb-3\">\r\n <div class=\"col-md-8 col-lg-8\">\r\n <div class=\"xp-invoice-note\">\r\n <p><span class=\"text-black f-w-5\">Esta cobrança é de responsabilidade única e exclusiva de <span id=\"lblDadosCliente\"><%=MEU_NOME%></span></p>\r\n </div>\r\n </div>\r\n <div class=\"col-md-4 col-lg-4\">\r\n <div class=\"xp-invoice-btn text-right\">\r\n <input type=\"submit\" name=\"btnPagar\" value=\"Pagar\" onclick=\"return buttonOnce('Pagar');\" id=\"btnPagar\" class=\"btn btn-rounded btn-success\" />\r\n </div>\r\n </div>\r\n </div>\r\n\r\n </div>\r\n </div>\r\n </div>\r\n </div>\r\n <!-- End XP Col -->\r\n\r\n </div>\r\n </div>\r\n <!-- End XP Contentbar -->\r\n <!-- Start XP Footerbar -->\r\n <div class=\"xp-breadcrumbbar text-center\">\r\n <footer class=\"footer\">\r\n <p class=\"mb-0\">© 2021 MeuK8.</p>\r\n </footer>\r\n </div>\r\n <!-- End XP Footerbar -->\r\n\r\n </div>\r\n <%=SCRIPTS%>\r\n <%=END_FORM%>\r\n</body>\r\n</html>",
"LayoutPaginaCompra": "<!DOCTYPE html>\r\n<html lang=\"en\">\r\n<head>\r\n <meta charset=\"UTF-8\">\r\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">\r\n <meta name=\"description\" content=\"Booster is a bootstrap & laravel admin dashboard template\">\r\n <meta name=\"keywords\" content=\"admin, admin dashboard, admin panel, admin template, admin theme, bootstrap 4, laravel, crm, analytics, responsive, sass support, ui kits, web app, clean design, creative\">\r\n <meta name=\"author\" content=\"Themesbox17\">\r\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0, user-scalable=0, minimal-ui\">\r\n\r\n <title>MeuK8 Cobranças - Link</title>\r\n\r\n <!-- Fevicon -->\r\n <link rel=\"shortcut icon\" href=\"assets/images/favicon.ico\">\r\n\r\n <!-- Start CSS -->\r\n <link href=\"assets/css/bootstrap.min.css\" rel=\"stylesheet\" type=\"text/css\">\r\n <link href=\"assets/css/icons.css\" rel=\"stylesheet\" type=\"text/css\">\r\n <link href=\"assets/css/style.css\" rel=\"stylesheet\" type=\"text/css\">\r\n <!-- End CSS -->\r\n\r\n</head>\r\n<body>\r\n <%=START_FORM%>\r\n <div>\r\n <!-- Start XP Breadcrumbbar -->\r\n <div class=\"xp-breadcrumbbar text-center\">\r\n <h8 class=\"page-title px-4\">Link de Pagamento</h8>\r\n <a href=\"login\" class=\"xp-web-logo\"><img src=\"assets/images/logoCheckout.png\" height=\"50\" alt=\"logo\"></a>\r\n </div>\r\n <!-- End XP Breadcrumbbar -->\r\n <!-- Start XP Contentbar -->\r\n <div class=\"xp-contentbar\">\r\n <div class=\"row\">\r\n <!-- Start XP Col -->\r\n <div class=\"col-md-12 col-lg-12 col-xl-12\">\r\n <div class=\"row\">\r\n <div class=\"col-sm\">\r\n <a href=\"#\" class=\"pull-right xp-web-logo\"><%=LOGO%></a>\r\n </div>\r\n <div id=\"cabecalhoHTML\" class=\"pull-left col-sm\"><%=CABECALHO%></div>\r\n </div>\r\n </div>\r\n <!-- End XP Col -->\r\n <!-- Start XP Col -->\r\n <div class=\"col-md-12 col-lg-12 col-xl-12\">\r\n <div class=\"card m-b-30\">\r\n <div class=\"card-body\">\r\n <div class=\"xp-invoice\">\r\n <div class=\"row mb-3\">\r\n <div class=\"col-sm-6 col-md-6 col-lg-6\">\r\n <div class=\"xp-invoice-address mb-4\">\r\n <p class=\"f-w-5 text-black\">Dados do Produto:</p>\r\n <h6><%=NOME_LINK%></h6>\r\n <p><%=VALOR_LINK%></p>\r\n <p><%=OBSERVACOES_LINK%></p>\r\n </div>\r\n </div>\r\n <div class=\"col-sm-6 col-md-6 col-lg-6\">\r\n <div class=\"xp-invoice-address mb-4\">\r\n <p class=\"f-w-5 text-black\"><%=IMAGEM_LINK%></p>\r\n </div>\r\n </div>\r\n </div>\r\n <div class=\"row mb-3 form-group\">\r\n <div class=\"col-sm-6 col-md-6 col-lg-6\">\r\n <div class=\"xp-invoice-address mb-4\">\r\n <p class=\"f-w-5 text-black\">Dados do Comprador:</p>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"valName\">Nome <span class=\"text-danger\">*</span></label>\r\n <input type=\"text\" class=\"form-control\" id=\"valName\" name=\"valName\" placeholder=\"nome\" value=\"\" />\r\n </div>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"valCPFCNPJ\">CPF/CNPJ <span class=\"text-danger\">*</span></label><br/>\r\n \t\t\t\t\t <label class=\"radio-inline\"><input type=\"radio\" id=\"optCPF\" name=\"optCPF\" onclick=\"changeToCPF();\">CPF</label>\r\n <label class=\"radio-inline\"><input type=\"radio\" id=\"optCNPJ\" name=\"optCPF\" onclick=\"changeToCNPJ();\">CNPJ</label>\r\n <input type=\"text\" class=\"form-control\" id=\"valCPFCNPJ\" name=\"valCPFCNPJ\" placeholder=\"cpf/cnpj\" value=\"\" />\r\n </div>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"valEMail\">E-Mail <span class=\"text-danger\">*</span></label>\r\n <input type=\"text\" class=\"form-control\" id=\"valEMail\" name=\"valEMail\" placeholder=\"e-mail\" value=\"\" />\r\n </div>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"valCelular\">Telefone Celular <span class=\"text-danger\">*</span></label>\r\n <input type=\"text\" class=\"form-control\" id=\"valCelular\" name=\"valCelular\" placeholder=\"celular\" value=\"\" />\r\n </div>\r\n </div>\r\n </div>\r\n <div class=\"col-sm-6 col-md-6 col-lg-6\">\r\n <div class=\"xp-invoice-address mb-4\">\r\n <p class=\"f-w-5 text-black\">Endereço do Comprador:</p>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"valCEP\">CEP <span class=\"text-danger\">*</span></label>\r\n <input type=\"text\" class=\"form-control\" id=\"valCEP\" name=\"valCEP\" placeholder=\"cep\" value=\"\" />\r\n </div>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"valEndereco\">Endereço <span class=\"text-danger\">*</span></label>\r\n <input type=\"text\" class=\"form-control\" id=\"valEndereco\" name=\"valEndereco\" placeholder=\"endereço\" value=\"\" />\r\n </div>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"valNumero\">Número <span class=\"text-danger\">*</span></label>\r\n <input type=\"text\" class=\"form-control\" id=\"valNumero\" name=\"valNumero\" placeholder=\"número\" value=\"\" />\r\n </div>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"valComplemento\">Complemento</label>\r\n <input type=\"text\" class=\"form-control\" id=\"valComplemento\" name=\"valComplemento\" placeholder=\"complemento\" value=\"\" />\r\n </div>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"valBairro\">Bairro <span class=\"text-danger\">*</span></label>\r\n <input type=\"text\" class=\"form-control\" id=\"valBairro\" name=\"valBairro\" placeholder=\"bairro\" value=\"\" />\r\n </div>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"valCidade\">Cidade <span class=\"text-danger\">*</span></label>\r\n <input type=\"text\" class=\"form-control\" name=\"valCidade\" placeholder=\"cidade\" value=\"\" />\r\n </div>\r\n <div class=\"col\">\r\n <label class=\"col-form-label\" for=\"ddUF\">UF <span class=\"text-danger\">*</span></label>\r\n <select id=\"ddUF\" name=\"ddUF\" class=\"form-control\">\r\n <option value=\"AC\">AC - Acre</option>\r\n <option value=\"AL\">AL - Alagoas</option>\r\n <option value=\"AM\">AM - Amazonas</option>\r\n <option value=\"AP\">AP - Amapá</option>\r\n <option value=\"BA\">BA - Bahia</option>\r\n <option value=\"CE\">CE - Ceará</option>\r\n <option value=\"DF\">DF - Distrito Federal</option>\r\n <option value=\"ES\">ES - Espírito Santo</option>\r\n <option value=\"GO\">GO - Goiás</option>\r\n <option value=\"MA\">MA - Maranhão</option>\r\n <option value=\"MG\">MG - Minas Gerais</option>\r\n <option value=\"MS\">MS - Mato Grosso do Sul</option>\r\n <option value=\"MT\">MT - Mato Grosso</option>\r\n <option value=\"PA\">PA - Pará</option>\r\n <option value=\"PB\">PB - Paraíba</option>\r\n <option value=\"PE\">PE - Pernambuco</option>\r\n <option value=\"PI\">PI - Piauí</option>\r\n <option value=\"PR\">PR - Paraná</option>\r\n <option value=\"RJ\">RJ - Rio de Janeiro</option>\r\n <option value=\"RN\">RN - Rio Grande do Norte</option>\r\n <option value=\"RO\">RO - Rondônia</option>\r\n <option value=\"RR\">RR - Roraima</option>\r\n <option value=\"RS\">RS - Rio Grande do Sul</option>\r\n <option value=\"SC\">SC - Santa Catarina</option>\r\n <option value=\"SE\">SE - Sergipe</option>\r\n <option value=\"SP\">SP - São Paulo</option>\r\n <option value=\"TO\">TO - Tocantins</option>\r\n </select>\r\n </div>\r\n </div>\r\n </div>\r\n </div>\r\n <div class=\"row mb-3\">\r\n <div class=\"col-md-12 col-lg-12\">\r\n <div class=\"xp-invoice-total text-right font-16\">\r\n <p>Valor Total : <span class=\"text-black f-w-5 text-success font-24\"><span id=\"lblValorTotal\"><%=VALOR_LINK%></span></span></p>\r\n </div>\r\n </div>\r\n </div>\r\n <div id=\"divMain\" class=\"row mb-3\">\r\n <div class=\"col-md-8 col-lg-8\">\r\n <div class=\"xp-invoice-note\">\r\n <p><span class=\"text-black f-w-5\">Esta cobrança é de responsabilidade única e exclusiva de <span id=\"lblDadosCliente\"><%=MEU_NOME%></span></p>\r\n </div>\r\n </div>\r\n <div class=\"col-md-4 col-lg-4\">\r\n <div class=\"xp-invoice-btn text-right\">\r\n <input type=\"submit\" name=\"btnPagar\" value=\"Pagar\" onclick=\"return buttonOnce('Pagar');\" id=\"btnPagar\" class=\"btn btn-rounded btn-success\" />\r\n </div>\r\n </div>\r\n </div>\r\n\r\n </div>\r\n </div>\r\n </div>\r\n </div>\r\n <!-- End XP Col -->\r\n\r\n </div>\r\n </div>\r\n <!-- End XP Contentbar -->\r\n <!-- Start XP Footerbar -->\r\n <div class=\"xp-breadcrumbbar text-center\">\r\n <footer class=\"footer\">\r\n <p class=\"mb-0\">© 2021 MeuK8.</p>\r\n </footer>\r\n </div>\r\n <!-- End XP Footerbar -->\r\n\r\n </div>\r\n <%=SCRIPTS%>\r\n <%=END_FORM%>\r\n</body>\r\n</html>",
"DataExpiracao": "2026-09-18T10:12:01.4199737-03:00",
"LinkReutilizavel": true,
"ParcelaFixa": false,
"ParcelaFixaQtd": 0
}
]Changes
No recorded changes to this operation across all 1 revision of this API.