Este endpoint 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 | Descrição | Obrigatório |
|---|---|---|---|
| Valor | Numérico | Valor da compra | Sim |
| Boleto | Objeto | Dados do boleto a ser gerado | Não (1) |
| DataVencimento | Data | Data de vencimento quando pago via boleto | Não(2) |
| Desconto | Numérico | Desconto para pagar via boleto (0 se não desejado) | Não |
| - | - | - | - |
| Pix | Objeto | Dados do pix a ser gerado | Não (1) |
| SegundosExpiracao | Número | 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(3) |
| Desconto | Numérico | 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 | Data de vencimento quando pago via pix | Sim(4) |
| Pdv | Booleano | Indicador 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 | Objeto | Dados do cartao a ser utilizado | Não (1) |
| FormaPagamento | Número | Forma de pagamento do cartão - "AVista" = 0, "ParceladoSemJuros" = 1, "ParceladoComJuros" = 2, se não for especificado, será definido automaticamente como 0 | Não |
| QuantidadeParcelas | Número | Quantidade de parcelas | Não (5) |
| - | - | - | - |
| ClienteEmail | Texto | E-mail do usuário final da compra | Não |
| ClienteCPFCNPJ | Texto | CPF ou CNPJ do cliente final da compra.Indicar somente os números | Sim |
| ClienteNome | Texto | Nome do cliente final da compra | Sim |
| ClienteEndereco | Texto | Endereço do cliente final da compra | Não (6) |
| ClienteComplemento | Texto | Complemento do endereço do cliente final da compra | Não |
| ClienteNumero | Texto | Número do endereço do cliente final da compra | Não (6) |
| ClienteBairro | Texto | Bairro do cliente final da compra | Não (6) |
| ClienteCidade | Texto | Cidade do cliente final da compra | Não (6) |
| ClienteCEP | Texto | CEP do cliente final da compra | Não (6) |
| ClienteUF | Texto | UF do cliente final da compra | Não (6) |
| ClienteDDD | Texto | DDD do telefone do cliente final da compra | Não |
| ClienteNumeroCelular | Texto | Número do telefone do cliente final da compra | Não |
| ClienteDescricao | Texto | Descrição da compra | Sim |
| ClienteIP | Texto | IP do usuário final da compra | Não |
| ClienteSexo | Texto | Sexo do cliente final da compra, podendo ser M (masculino) ou F (feminino) | Não |
| URLRetorno | Texto | URL de retorno do comércio após a conclusão do pagamento na página de checkout | Sim |
| URLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final | Não |
| NumeroPedido | Texto | Número do pedido no sistema do comércio | Não |
| Referencia | Texto | Referência para localização futura do boleto | Não |
(1) - Ao menos uma forma de pagamento deve ser preenchida. Se mais de uma forma de pagamento for preenchida, o cliente poderá escolher a forma de pagamento desejada no momento do checkout. Caso apenas uma forma de pagamento seja preenchida, esta será a única opção disponível para o cliente no checkout.
(2) - Obrigatório caso informado Boleto
(3) - Para pagamentos com Pix. Quando PDV = true, DataVencimento não pode ser preenchido
(4) - Obrigatório caso seja pagamento Pix e PDV = false
(5) - Obrigatório caso a FormaPagamento 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) - Obrigatório caso permita pagamento com boleto, se não for preenchido, o sistema não conseguirá gerar o boleto corretamente
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 |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||