v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBCria uma transação com página de checkout completo
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. <br /> 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. <br /> É 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. <br /> 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. <br /> 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. <br />
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
Request body
Example request
{
"Valor": 0,
"Boleto": {
"DataVencimento": "2026-06-05T09:47:50.9994596-03:00",
"Desconto": 0
},
"Pix": {
"SegundosExpiracao": 300,
"Desconto": 0,
"Tipo": "E",
"DataVencimento": "2026-05-23T09:47:50.9994596-03:00",
"Pdv": false
},
"Cartao": {
"FormaPagamento": [
"ParceladoSemJuros",
"AVista"
],
"QuantidadeParcelas": 4
},
"ClienteEmail": "renatosamuel@umdominio.com.br",
"ClienteCPFCNPJ": "48455151480",
"ClienteNome": "Renato Samuel Augusto Baptista",
"ClienteEndereco": "Rua Canadá, 257",
"ClienteComplemento": "",
"ClienteNumero": "22",
"ClienteBairro": "Bacacheri",
"ClienteCidade": "Curitiba",
"ClienteCEP": "82510290",
"ClienteUF": "PR",
"ClienteDDD": "41",
"ClienteNumeroCelular": "999293802",
"ClienteDescricao": "Cliente Gold Nivel 25",
"ClienteIP": "127.0.0.1",
"ClienteSexo": "M",
"URLRetorno": "https://www.meusite.com.br/webhook/confirmacao-transacao",
"URLConfirmacao": "https://www.meusite.com.br/webhook/confirmacao-transacao",
"NumeroPedido": "pedido.2026052109",
"Referencia": "pag123"
}Response
Método executado com sucesso