post https://pagamentos.k8bank.com.br/PagamentosAPI/api/CriaTransacaoCheckout
Este método permite a criação de transações de pagamento por meio de um "checkout completo", oferecendo opções de pagamento via Boleto, Cartão de Crédito e Pix.
Ao utilizar esse método, é possível configurar diferentes modalidades de pagamento para cada uma das 3 opções, permitindo que o cliente escolha sua preferência no momento da compra.
É viável personalizar condições de desconto para pagamentos via boleto ou Pix, e definir se os pagamentos com cartão podem ser à vista, parcelados com juros pela operadora ou parcelados diretamente com o varejista, com a possibilidade de especificar acréscimos nos valores devido ao parcelamento.
Após a chamada do método, os sistemas retornam a URL da página de checkout.O cliente será redirecionado para esta página a fim de efetuar o pagamento e, posteriormente, será redirecionado para uma página específica de retorno da empresa.
Também é possível indicar uma página de confirmação que o sistema acionará assim que a transação for concluída com sucesso.
Requisição
| Campo | Tipo | Tamanho | Descrição |
|---|---|---|---|
| Valor | Numérico com 2 decimais | 12 | Valor da compra. |
| BoletoDataVencimento | Data | 8 | Data de vencimento quando pago via boleto. |
| DescontoBoleto | Numérico com 2 decimais | 12 | Desconto para pagar via boleto (0 se não desejado). |
| PixSegundosExpiracao | Numérico Inteiro | 6 | Segundos para realizar o pagamento via Pix, com valor mínimo de 300 (5 minutos) e máximo de 2592000 (30 dias). |
| DescontoPix | Numérico com 2 decimais | 12 | Desconto para pagar via pix(0 se não desejado) |
| TipoPix | Texto | - | - |
| HabilitadoCartaoAVista | Boleano | – | Indica que o pagamento via cartão de crédito na forma a vista(sem parcelamento) está habilitado |
| HabilitadoCartaoAPrazoComJuros | Boleano | – | Indica que o pagamento via cartão de crédito na forma a prazo com juros(via operadora) está habilitado |
| MaximoParcelasComJuros | Numérico com 2 decimais | 2 | Número máximo de parcelas permitido para o pagamento via cartão de crédito na forma a prazo com juros(via operadora) |
| HabilitadoCartao2Parcelas | Boleano | – | Indica se o pagamento no cartão parcelado via lojista em 2 parcelas está habilitado |
| PercentualPrecoCartao2Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 2 parcelas.Por exemplo, para manter o valor sem juros, especificar 100. Se for desejado incluir um juros de 2%, especificar 102. |
| HabilitadoCartao3Parcelas | Boleano | – | Indica se o pagamento no cartão parcelado via lojista em 3 parcelas está habilitado |
| PercentualPrecoCartao3Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 3 parcelas. |
| HabilitadoCartao4Parcelas | Boleano | – | Indica se o pagamento no cartão parcelado via lojista em 4 parcelas está habilitado |
| PercentualPrecoCartao4Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 4 parcelas. |
| HabilitadoCartao5Parcelas | Boleano | – | Indica se o pagamento no cartão parcelado via lojista em 5 parcelas está habilitado |
| PercentualPrecoCartao5Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 5 parcelas. |
| HabilitadoCartao6Parcelas | Boleano | – | Indica se o pagamento no cartão parcelado via lojista em 6 parcelas está habilitado |
| PercentualPrecoCartao6Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 6 parcelas. |
| HabilitadoCartao7Parcelas | Boleano | – | Indica se o pagamento no cartão parcelado via lojista em 7 parcelas está habilitado |
| PercentualPrecoCartao7Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 7 parcelas. |
| HabilitadoCartao8Parcelas | Boleano | – | Indica se o pagamento no cartão parcelado via lojista em 8 parcelas está habilitado |
| PercentualPrecoCartao8Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 8 parcelas. |
| HabilitadoCartao9Parcelas | Boleano | – | Indica se o pagamento no cartão parcelado via lojista em 9 parcelas está habilitado |
| PercentualPrecoCartao9Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 9 parcelas. |
| HabilitadoCartao10Parcelas | Boleano | – | Indica se o pagamento no cartão parcelado via lojista em 10 parcelas está habilitado |
| PercentualPrecoCartao10Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 10 parcelas. |
| HabilitadoCartao11Parcelas | Boleano | - | Indica se o pagamento no cartão parcelado via lojista em 11 parcelas está habilitado |
| PercentualPrecoCartao11Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 11 parcelas. |
| HabilitadoCartao12Parcelas | Boleano | – | Indica se o pagamento no cartão parcelado via lojista em 12 parcelas está habilitado |
| PercentualPrecoCartao12Parcelas | Numérico com 2 decimais | 3 | Percentual do preço para pagamento no cartão parcelado via lojista em 12 parcelas. |
| ClienteEmail | Texto | 512 | E-mail do usuário final da compra(opcional). |
| ClienteCPFCNPJ | Texto somente com números(11/14 posições) | 14 | CPF ou CNPJ do cliente final da compra.Indicar somente os números. |
| ClienteNome | Texto | 512 | Nome do cliente final da compra. |
| ClienteDescricao | Texto | 100 | Descrição da compra. |
| ClienteIP | Texto | 40 | IP do usuário final da compra. |
| ClienteEndereco | Texto | 100 | Endereço do cliente final da compra (opcional). |
| ClienteBairro | Texto | 30 | Bairro do cliente final da compra (opcional). |
| ClienteCidade | Texto | 30 | Cidade do cliente final da compra (opcional). |
| ClienteCEP | Texto | 8 | CEP do cliente final da compra (opcional). |
| ClienteUF | Texto | 2 | UF do cliente final da compra (opcional). |
| ClienteDDD | Texto | 2 | DDD do telefone do cliente final da compra (opcional). |
| ClienteNumeroCelular | Texto | 9 | Número do telefone do cliente final da compra (opcional). |
| ClienteSexo | Texto | 1 | Sexo do cliente final da compra, podendo ser M (masculino) ou F (feminino) (opcional). |
| ClienteComplemento | Texto | 10 | Complemento do endereço do cliente final da compra (opcional). |
| ClienteNumero | Texto | 30 | Número do endereço do cliente final da compra (opcional). |
| URLRetorno | Texto | 512 | URL de retorno do comércio após a conclusão do pagamento na página de checkout |
| URLConfirmacao | Texto | 512 | URL de confirmação do comércio para indicar que o pagamento está em estado final. |
| Referencia | Texto | - | Referência para localização futura do boleto (opcional) |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Retorno | Texto | Retorno da chamada, podendo possuir os valores OK ou ERRO. |
| DetalhesErro | Texto | Detalhes do erro gerado, caso o retorno seja ERRO. |
| Identificador | Texto | Identificador da transação gerada, caso chamada seja exitosa |
| URL | Texto | URL para direcionamento do usuário para realizar o pagamento, caso chamada seja exitosa |