Documentação das APIs

Cria Transação Checkout

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

CampoTipoTamanhoDescrição
ValorNumérico com 2 decimais12Valor da compra.
BoletoDataVencimentoData8Data de vencimento quando pago via boleto.
DescontoBoletoNumérico com 2 decimais12Desconto para pagar via boleto (0 se não desejado).
PixSegundosExpiracaoNumérico Inteiro6Segundos para realizar o pagamento via Pix, com valor mínimo de 300 (5 minutos) e máximo de 2592000 (30 dias).
DescontoPixNumérico com 2 decimais12Desconto para pagar via pix(0 se não desejado)
HabilitadoCartaoAVistaBoleanoIndica que o pagamento via cartão de crédito na forma a vista(sem parcelamento) está habilitado
HabilitadoCartaoAPrazoComJurosBoleanoIndica que o pagamento via cartão de crédito na forma a prazo com juros(via operadora) está habilitado
MaximoParcelasComJurosNumérico com 2 decimais2Número máximo de parcelas permitido para o pagamento via cartão de crédito na forma a prazo com juros(via operadora)
HabilitadoCartao2ParcelasBoleanoIndica se o pagamento no cartão parcelado via lojista em 2 parcelas está habilitado
PercentualPrecoCartao2ParcelasNumérico com 2 decimais3Percentual 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.
HabilitadoCartao3ParcelasBoleanoIndica se o pagamento no cartão parcelado via lojista em 3 parcelas está habilitado
PercentualPrecoCartao3ParcelasNumérico com 2 decimais3Percentual do preço para pagamento no cartão parcelado via lojista em 3 parcelas.
HabilitadoCartao4ParcelasBoleanoIndica se o pagamento no cartão parcelado via lojista em 4 parcelas está habilitado
PercentualPrecoCartao4ParcelasNumérico com 2 decimais3Percentual do preço para pagamento no cartão parcelado via lojista em 4 parcelas.
HabilitadoCartao5ParcelasBoleanoIndica se o pagamento no cartão parcelado via lojista em 5 parcelas está habilitado
PercentualPrecoCartao5ParcelasNumérico com 2 decimais3Percentual do preço para pagamento no cartão parcelado via lojista em 5 parcelas.
HabilitadoCartao6ParcelasBoleanoIndica se o pagamento no cartão parcelado via lojista em 6 parcelas está habilitado
PercentualPrecoCartao6ParcelasNumérico com 2 decimais3Percentual do preço para pagamento no cartão parcelado via lojista em 6 parcelas.
HabilitadoCartao7ParcelasBoleanoIndica se o pagamento no cartão parcelado via lojista em 7 parcelas está habilitado
PercentualPrecoCartao7ParcelasNumérico com 2 decimais3Percentual do preço para pagamento no cartão parcelado via lojista em 7 parcelas.
HabilitadoCartao8ParcelasBoleanoIndica se o pagamento no cartão parcelado via lojista em 8 parcelas está habilitado
PercentualPrecoCartao8ParcelasNumérico com 2 decimais3Percentual do preço para pagamento no cartão parcelado via lojista em 8 parcelas.
HabilitadoCartao9ParcelasBoleanoIndica se o pagamento no cartão parcelado via lojista em 9 parcelas está habilitado
PercentualPrecoCartao9ParcelasNumérico com 2 decimais3Percentual do preço para pagamento no cartão parcelado via lojista em 9 parcelas.
HabilitadoCartao10ParcelasBoleanoIndica se o pagamento no cartão parcelado via lojista em 10 parcelas está habilitado
PercentualPrecoCartao10ParcelasNumérico com 2 decimais3Percentual do preço para pagamento no cartão parcelado via lojista em 10 parcelas.
HabilitadoCartao11ParcelasBoleano-Indica se o pagamento no cartão parcelado via lojista em 11 parcelas está habilitado
PercentualPrecoCartao11ParcelasNumérico com 2 decimais3Percentual do preço para pagamento no cartão parcelado via lojista em 11 parcelas.
HabilitadoCartao12ParcelasBoleanoIndica se o pagamento no cartão parcelado via lojista em 12 parcelas está habilitado
PercentualPrecoCartao12ParcelasNumérico com 2 decimais3Percentual do preço para pagamento no cartão parcelado via lojista em 12 parcelas.
ClienteEmailTexto512E-mail do usuário final da compra(opcional).
ClienteCPFCNPJTexto somente com números(11/14 posições)14CPF ou CNPJ do cliente final da compra.Indicar somente os números.
ClienteNomeTexto512Nome do cliente final da compra.
ClienteDescricaoTexto100Descrição da compra.
ClienteIPTexto40IP do usuário final da compra.
ClienteEnderecoTexto100Endereço do cliente final da compra (opcional).
ClienteBairroTexto30Bairro do cliente final da compra (opcional).
ClienteCidadeTexto30Cidade do cliente final da compra (opcional).
ClienteCEPTexto8CEP do cliente final da compra (opcional).
ClienteUFTexto2UF do cliente final da compra (opcional).
ClienteDDDTexto2DDD do telefone do cliente final da compra (opcional).
ClienteNumeroCelularTexto9Número do telefone do cliente final da compra (opcional).
ClienteSexoTexto1Sexo do cliente final da compra, podendo ser M (masculino) ou F (feminino) (opcional).
ClienteComplementoTexto10Complemento do endereço do cliente final da compra (opcional).
ClienteNumeroTexto30Número do endereço do cliente final da compra (opcional).
URLRetornoTexto512URL de retorno do comércio após a conclusão do pagamento na página de checkout
URLConfirmacaoTexto512URL de confirmação do comércio para indicar que o pagamento está em estado final.

Resposta

CampoTipoDescrição
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO.
DetalhesErroTextoDetalhes do erro gerado, caso o retorno seja ERRO.
IdentificadorTextoIdentificador da transação gerada, caso chamada seja exitosa
URLTextoURL para direcionamento do usuário para realizar o pagamento, caso chamada seja exitosa
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!