---
title: "Cria uma transação com página de checkout completo"
method: POST
path: "/v2/CriaTransacaoCheckout"
tags: ["CriaTransacaoCheckout"]
---
# Cria uma transação com página de checkout completo
`POST /v2/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** | **Obrigatório** |
|--|--|--|--|--|
| Valor | Numérico com 2 decimais| 12 |Valor da compra |Sim|
| **Boleto** | - | - |.- | - |
| DataVencimento | Data | 8 |Data de vencimento quando pago via boleto |Sim(1)|
| Desconto | Numérico com 2 decimais |12| Desconto para pagar via boleto (0 se não desejado) |Não|
| **Pix** | - | - |- |-|
| SegundosExpiracao | Numérico Inteiro|6| Segundos para realizar o pagamento via Pix. Quando PDV = true: intervalo de 30 a 2.592.000 segundos. Quando PDV = false: intervalo de 300 a 2.592.000 segundos |Sim(2)|
| Desconto | Numérico com 2 decimais| 12| Desconto para pagar via pix(0 se não desejado)|Não|
| Tipo | Texto | - | Informar D = para tipo de pix dinâmico, e E = para tipo de pix estático, se não for especificado, será definido automaticamente como D |Não|
| DataVencimento | Data | 8 |Data de vencimento quando pago via pix |Sim(1)|
| Pdv | Booleano | - | Indica se a transação foi realizada em um ponto de venda físico (PDV). Quando definido como true, a transação passa a seguir regras e validações específicas. |Não|
| **Cartao** | - | - |- |-|
| FormaPagamento | Numérico| 1| Forma de pagamento do cartão, se não for especificado, será definido automaticamente como 0 (À Vista) | Não(3)(4) |
| QuantidadeParcelas | Numérico | 1 |Quantidade de parcelas | Sim(3)(5) |
| **Demais campos do payload** | - | - | - |-|
| ClienteEmail | Texto | 512 | E-mail do usuário final da compra |Não|
| ClienteCPFCNPJ | Texto |11-14| CPF ou CNPJ do cliente final da compra.Indicar somente os números |Sim|
| ClienteNome | Texto | 100 | Nome do cliente final da compra |Sim|
| ClienteDescricao | Texto | 100 | Descrição da compra |Sim|
| ClienteIP | Texto |40 | IP do usuário final da compra |Não|
| ClienteEndereco | Texto |100 | Endereço do cliente final da compra |Não|
| ClienteBairro | Texto | 30 | Bairro do cliente final da compra |Não|
| ClienteCidade | Texto | 30 | Cidade do cliente final da compra |Não|
| ClienteCEP | Texto | 8 | CEP do cliente final da compra |Não|
| ClienteUF | Texto | 2 | UF do cliente final da compra |Não|
| ClienteDDD | Texto | 2 | DDD do telefone do cliente final da compra |Não|
| ClienteNumeroCelular | Texto | 9 | Número do telefone do cliente final da compra |Não|
| ClienteSexo | Texto | 1 | Sexo do cliente final da compra, podendo ser M (masculino) ou F (feminino) |Não|
| ClienteComplemento | Texto | 10 | Complemento do endereço do cliente final da compra |Não|
| ClienteNumero | Texto | 30 | Número do endereço do cliente final da compra |Não|
| URLRetorno | Texto | 512 | URL de retorno do comércio após a conclusão do pagamento na página de checkout|Sim|
| URLConfirmacao | Texto | 512 | URL de confirmação do comércio para indicar que o pagamento está em estado final |Não|
| Referencia | Texto | 32 | Referência para localização futura do boleto |Não|
(1) - Para pagamentos com Boleto ou Pix (quando PDV = false)
(2) - Para pagamentos com Pix. Quando PDV = true, DataVencimento não pode ser preenchido
(3) - Para pagamentos com Cartão
(4) - Forma de pagamento do cartão, sendo possível os valores: 0 = A Vista; 1 = Parcelado sem juros; 2 = Parcelado com juros.
(5) - Quantidade de parcelas, caso a forma de pagamento seja parcelada.Válidos valores de 2 até 12. Caso seja a vista, pode-se não enviar o valor ou enviar 0 ou 1.
(6) - Deve ser preenchido se o FormaDePagamento for parcelado com juros. Esse campo permite você definir a quantidade de juros de acordo com a quantidade de parcelas.
**Atualmente, a opção de pagamento Parcelado com Juros está desativada na tela de checkout.**
### 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|
## Headers
- `Aeskey` string, required
## Request body
- BknBankPagamentosBusinessCriaTransacaoCheckoutRequest
- `Valor` number, double
- `Boleto` BknBankPagamentosBusinessCriaTransacaoCheckoutBoletoRequest
- `DataVencimento` string, date-time
- `Desconto` number, double
- `Pix` BknBankPagamentosBusinessCriaTransacaoCheckoutPixRequest
- `SegundosExpiracao` integer
- `Desconto` number, double
- `Tipo` string, required
- `DataVencimento` string, date-time
- `Pdv` boolean
- `Cartao` BknBankPagamentosBusinessCriaTransacaoCheckoutCartaoRequest
- `FormaPagamento` string[]
- `QuantidadeParcelas` integer
- `PercentualJuros` object
- `ClienteEmail` string
- `ClienteCPFCNPJ` string, required
- `ClienteNome` string, required
- `ClienteEndereco` string
- `ClienteComplemento` string
- `ClienteNumero` string
- `ClienteBairro` string
- `ClienteCidade` string
- `ClienteCEP` string
- `ClienteUF` string
- `ClienteDDD` string
- `ClienteNumeroCelular` string
- `ClienteDescricao` string, required
- `ClienteIP` string
- `ClienteSexo` string
- `URLRetorno` string, required
- `URLConfirmacao` string
- `NumeroPedido` string
- `Referencia` string
## Response `200`
Método executado com sucesso
- BknBankPagamentosBusinessCriaTransacaoCheckoutResponse
- `Retorno` 'OK' | 'ERRO'
- `DetalhesErro` string
- `Identificador` string
- `URL` string
## Other responses
- `500` — Erro executando método
---
[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)