v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
LinkPagamento

Atualiza um link de pagamento por Id

Esta API oferece a funcionalidade de atualizar links de pagamento, permitindo que você modifique as informações de um link já criado. Para atualizar um link de pagamento, você precisa utilizar o método PUT. Esse método recebe um objeto JSON com as informações atualizadas do link de pagamento como parâmetro e não retorna nenhuma resposta.

Requisição

CampoTipoDescriçãoObrigatório
IdGUIDId do link de pagamentoSim
NomeTextoNome do link de pagamentoSim
TipoValorTextoTipo do valor do link de pagamentoNão
ValorNúmeroValor do link de pagamentoNão
FormasPagamentoTextoFormas de pagamento do link de pagamentoNão
CriacaoTextoData de criação do link de pagamentoNão
ObservacoesTextoObservações do link de pagamentoSim
AtivoBooleanoRetorna true ou false, para identificar do status do link de pagamento.Não
LayoutPaginaInicialTextoLayout da página inicial do link de pagamento.Não
LayoutPaginaCompraTextoLayout da página de compra do link de pagamento.Não
DataExpiracaoTextoData de expiração do link de consulta da compra.Não
LinkReutilizavelBooleanoInforma se o link de pagamento pode ser reutilizado.Não
ParcelaFixaBooleanoEspecifica se o link de pagamento possui ou não parcelamento de cartão.Não
ParcelaFixaQtdNúmeroDefine o número máximo de parcelas permitido para o link de pagamento.Não
put/api/LinkPagamento

Headers

Aeskeystring required

Request body

Idstring

Id do link de pagamento

Nomestring required

Nome do link de pagamento

TipoValor'fixo' | 'variavel'

Tipo do valor do link de pagamento

Valornumber double

Valor do link de pagamento

FormasPagamento'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta'

Formas de pagamento do link de pagamento

Observacoesstring required

Observações do link de pagamento

Ativoboolean

Indicativo de ativo do link de pagamento

LayoutPaginaInicialstring

Layout da pagina inicial do link de pagamento

LayoutPaginaComprastring

Layout da pagina de compra do link de pagamento

DataExpiracaostring date-time

Data de expiracao do link de pagamento

LinkReutilizavelboolean

Indica se o Link de pagamento é reutilizável após pago

ParcelaFixaboolean

Indica se o Link de pagamento tem parcelamento diferente da configuracao geral

ParcelaFixaQtdinteger

Indica qual o maximo de parcelas o Link de pagamento pode ter

Example request

{
  "Id": "bb93bed5-645b-47e9-a098-2b4a650342f8",
  "Nome": "Link de pagamento exemplo",
  "TipoValor": "fixo",
  "Valor": 10.35,
  "FormasPagamento": "Pix",
  "Observacoes": "Descreva algo sobre o pagamento neste campo",
  "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(&#39;Pagar&#39;);\" 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&#225;</option>\r\n                                                        <option value=\"BA\">BA - Bahia</option>\r\n                                                        <option value=\"CE\">CE - Cear&#225;</option>\r\n                                                        <option value=\"DF\">DF - Distrito Federal</option>\r\n                                                        <option value=\"ES\">ES - Esp&#237;rito Santo</option>\r\n                                                        <option value=\"GO\">GO - Goi&#225;s</option>\r\n                                                        <option value=\"MA\">MA - Maranh&#227;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&#225;</option>\r\n                                                        <option value=\"PB\">PB - Para&#237;ba</option>\r\n                                                        <option value=\"PE\">PE - Pernambuco</option>\r\n                                                        <option value=\"PI\">PI - Piau&#237;</option>\r\n                                                        <option value=\"PR\">PR - Paran&#225;</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&#244;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&#227;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(&#39;Pagar&#39;);\" 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-06-20T10:45:47.4985304-03:00",
  "LinkReutilizavel": true,
  "ParcelaFixa": false,
  "ParcelaFixaQtd": 0
}

Response

Link de pagamento atualizado

Requestobject