Configurações do Checkout

❗️

Você está na versão correta da documentação?

Verifique na sua Dashboard a versão da API que você está usando. Você deve usar a documentação correspondente. Para saber mais, veja: Versionamento.

O checkout possui diversos outros campos de customização que podem ser passados na sua construção. Segue um overview de todos parâmetros possíveis:

Configurações da versão formulário

TagPadrãoDescrição
data-encryption-key---Chave de encriptação disponível na sua Dashboard.
Tipo: string
data-amount---Valor da transação (em centavos) a ser capturada pelo Checkout. Ex: R$14,79 = 1479
Tipo: integer
data-button-textPagarTexto mostrado no botão de pagamento.
Tipo: string
data-button-class---Classe CSS a ser adicionada no botão de pagamento.
Tipo: string
data-boleto-discount-amount---Valor, em centavos, do desconto caso o meio de pagamento seja boleto. Ex: desconto de R$10,00 = 1000. OBS: você não pode adicionar essa tag caso a tag de desconto percentual já esteja presente.
Tipo: integer
data-boleto-discount-percentage---Percentual de desconto caso o meio de pagamento seja boleto. Ex: desconto de 25% = 25. OBS: você não pode adicionar essa tag caso a tag de desconto por valor já esteja presente.
Tipo: integer
data-boleto-helper-text---Mensagem opcional que aparece embaixo do botão de pagamento Boleto.
Tipo: string
data-credit-card-helper-text---Mensagem opcional que aparece embaixo do botão de pagamento Cartão de Crédito.
Tipo: string
data-payment-methodscredit_card, boletoMeios de pagamento disponíveis no Checkout.
Tipo: string
data-card-brandselo, amex, diners, jcb, hipercard, visa, aura, discover, mastercardVocê deve especificar aqui quais bandeiras quer aceitar.
Tipo: string
data-default-installment---Número de parcelas que virá selecionado ao abrir o checkout
Tipo: integer
data-max-installments1Número máximo de parcelas aceitas, de 1 a 12.
Tipo: integer
data-min-installments---Número mínimo de parcelas aceitas, de 1 a 12.
Tipo: integer
data-ui-color#1a6ee1Cor primária da interface de Checkout.
Tipo: string
data-postback-url---Endereço da URL de postback do seu sistema, que recebe as notificações das alterações de status das transações
Tipo: string
data-create-tokentrueHabilita a geração do token para autorização da transação.
OBS: Caso você queira apenas pegar os dados do cliente, deixe esse atributo com o valor false, e realize a transação normalmente no seu backend, com os dados informados no formulário do Checkout.
Tipo: boolean
data-customer-datatrueHabilita os campos de endereço, telefone, nome e email do cliente. Caso você não queira capturar estes dados pelo Checkout, configure como false.
Tipo: boolean
data-customer-name---Nome do cliente (Obrigatório)
Tipo: string
data-customer-document-number---CPF ou CNPJ do cliente (Obrigatório)
Tipo: string
data-customer-email---E-mail do cliente (Obrigatório)
Tipo: string
data-customer-address-street---Nome do logradouro do cliente
Tipo: string
data-customer-address-street-number---Número do imóvel do cliente
Tipo: integer
data-customer-address-complementary---Complemento do endereço do cliente
Tipo: string
data-customer-address-neighborhood---Bairro do cliente
Tipo: string
data-customer-address-city---Cidade do cliente
Tipo: string
data-customer-address-state---Estado (unidade federativa) do cliente
Tipo: string
data-customer-address-zipcode---Código de endereçamento postal (CEP) da cidade do cliente
Tipo: string
data-customer-phone-ddd---DDD do telefone do cliente
Tipo: integer
data-customer-phone-number---Número do telefone do cliente
Tipo: integer
data-disable-zero-document-numberfalseNão aceita CPF ou CNPJ em que todos os números são zeros
Tipo: boolean
data-interest-rate---Taxa de juros a ser cobrada na transação.
OBS: Apenas para cartão de crédito.
Tipo: integer
data-free-installments---Número de parcelas que não terão juros cobrados
Tipo: integer
data-default-installment1Define a parcela padrão selecionada ao abrir o Checkout
Tipo: integer
data-header-textTotal a pagar {price_info}Define o texto do cabeçalho.
OBS: Você pode utilizar a variável {price_info} para injetar o valor do pagamento no texto.
Tipo: string
data-payment-button-textPagarDefine o texto mostrado no botão de confirmação de pagamento.
Tipo: string

Configurações da versão API

TagPadrãoDescrição
amount---Valor da transação (em centavos) a ser capturada pelo Checkout. Ex: R$14,79 = 1479
Tipo: integer
buttonTextPagarTexto mostrado no botão de pagamento.
Tipo: string
buttonClass---Classe CSS a ser adicionada no botão de pagamento.
Tipo: string
customerDatatrueCaso não queira capturar dados do cliente pelo Checkout, configurar como false.
Tipo: boolean
paymentMethodscredit_card, boletoMeios de pagamento disponíveis no Checkout.
Tipo: string
card_brandselo, amex, diners, jcb, hipercard, visa, aura, discover, mastercardVocê deve especificar aqui quais bandeiras quer aceitar.
Tipo: string
maxInstallments1Número máximo de parcelas aceitas, de 1 a 12.
Tipo: integer
defaultInstallments---Número de parcelas que virá selecionado ao abrir o checkout
Tipo: integer
minInstallments---Número mínimo de parcelas aceitas, de 1 a 12.
Tipo: integer
freeInstallments---Quantidade de parcelas onde não haverá cobrança de juros
Tipo: integer
interestRate---Percentual de juros que serão aplicados a partir de uma determinada parcela
Tipo: decimal
uiColor#1a6ee1Cor primária da interface de Checkout.
Tipo: string
postbackUrl---Endereço da URL de postback do seu sistema, que receberá as notificações das alterações de status das transações
Tipo: string
createToken"true"Habilita a geração do token para autorização da transação.
Obs.: Caso você deseje apenas utilizar o checkout como formulário, deixe esse atributo com o valor false, e realize a transação normalmente no seu backend.
Tipo: boolean
customerName---Nome do cliente (Obrigatório)
Tipo: string
customerDocumentNumber---CPF ou CNPJ do cliente (Obrigatório)
Tipo: string
customerEmail---E-mail do cliente (Obrigatório)
Tipo: string
customerAddressStreet---Nome do logradouro do cliente
Tipo: string
customerAddressStreetNumber---Número do imóvel do cliente
Tipo: integer
customerAddressComplementary---Complemento do endereço do cliente
Tipo: string
customerAddressNeighborhood---Bairro do cliente
Tipo: string
customerAddressCity---Cidade do cliente
Tipo: string
customerAddressState---Estado (unidade federativa) do cliente
Tipo: string
customerAddressZipcode---Código de endereçamento postal (CEP) da cidade do cliente
Tipo: string
customerPhoneDdd---DDD do telefone do cliente
Tipo: integer
customerPhoneNumber---Número do telefone do cliente
Tipo: integer
disableZeroDocumentNumber"false"Não aceita CPF ou CNPJ em que todos os números são zeros
Tipo: boolean
interestRate---Taxa de juros a ser cobrada na transação
Tipo: integer
headerTextTotal a pagar {price_info}Define o texto do cabeçalho.
OBS: Você poderá utilizar a variável {price_info} para injetar o valor do pagamento no texto.
Tipo: string
paymentButtonTextPagarDefine o texto do botão final de pagamento.
Tipo: string
boletoDiscountPercentage---Define a porcentagem de desconto no boleto.
Tipo: integer
boletoDIscountAmount---Define o valor de desconto (em centavos) no boleto. Ex: R$10.00 de desconto = 1000.
Tipo: integer
boletoExpirationDate---Define a data de validade do boleto. Ex.: '20/12/2020'
Tipo: string
creditCardDiscountPercentage---Define a porcentagem de desconto na primeira parcela de cartão de crédito (pagamento à vista).
Tipo: integer
creditCardDiscountAmount---Define o valor de desconto (em centavos) na primeira parcela de cartão de crédito (pagamento à vista). Ex: R$10.00 de desconto = 1000.
Tipo: integer

👍

Exemplo do Checkout

É possível testar os parâmetros que irá utilizar clicando aqui.