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:
| Tag | Padrão | Descrição |
|---|---|---|
| amount | --- | Valor da transação (em centavos) a ser capturada pelo Checkout. Ex: R$14,79 = 1479Tipo: string |
| buttonText | Pagar | Texto do botão de pagamento. Tipo: string |
| buttonClass | --- | Classe CSS a ser adicionada no botão de pagamento. Tipo: string |
| customerData | true | Caso não deseje capturar dados do cliente pelo Checkout, setar como false.Tipo: boolean |
| reviewInformations | 'false' | Mostra os dados inseridos pelo cliente para revisão no formulário do checkout. Para que isso aconteça, o campo customerData precisa estar como true e os objetos customer, billing e shipping precisam estar presentes no JSON de dados do checkout.Type: boolean |
| paymentMethods | credit_card, boleto | Meios de pagamento disponíveis no Checkout. Tipo: string |
| card_brands | elo, amex, diners, jcb, hipercard, visa, aura, discover, mastercard | Você deve especificar aqui quais bandeiras quer aceitar. Tipo: string |
| maxInstallments | 1 | Nú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 | #1a6ee1 | Cor 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 |
| customer | --- | Informações do cliente Tipo: object |
| customer.external_id | --- | Número de identificação do cliente na loja Tipo: string |
| customer.name | --- | Nome do cliente Tipo: string (Obrigatório) |
| customer.type | --- | Tipo de cliente (individual ou corporation)Tipo: string |
| customer.country | --- | País de origem do cliente Tipo: string |
| customer.email | --- | Email do cliente Tipo: string (Obrigatório) |
| customer.documents | --- | Lista de documentos do cliente Tipo: array (Obrigatório) |
| customer.documents.type | --- | Tipo do documento (CPF ou CNPJ) Tipo: string (Obrigatório) |
| customer.documents.number | --- | Número do documento Tipo: string (Obrigatório) |
| customer.phone_numbers | --- | Lista de telefones do cliente Tipo: array |
| customer.birthday | --- | Data de nascimento do cliente Tipo: string |
| billing | --- | Informações de cobrança (obrigatório em caso de createToken:true e customerData:false) Tipo: object |
| billing.name | --- | Nome da entidade de cobrança Tipo: string |
| billing.address | --- | Dados de endereço de cobrança Tipo: object |
| billing.address.street | --- | Rua Tipo: string |
| billing.address.street_number | --- | Número Tipo: string |
| billing.address.zipcode | --- | CEP Tipo: string |
| billing.address.country | --- | País. Deve seguir o padão ISO 3166-1 alpha-2 Tipo: string |
| billing.address.state | --- | Estado Tipo: string |
| billing.address.city | --- | Cidade Tipo: string |
| billing.address.neighborhood | --- | Bairro Tipo: string |
| billing.address.complementary | --- | Complemento. Não deve ser uma string vazia nem null. Tipo: string |
| shipping | --- | Informações de entrega (obrigatório quando há bens físicos entre os itens vendidos) Tipo: object |
| shipping.name | --- | Nome do comprador Tipo: string |
| shipping.fee | --- | Taxa de envio cobrada do comprador. Por exemplo, se a taxa de envio é de dez reais e três centavos (R$10,03), o valor deve ser fornecido como ‘1003’ Tipo: integer |
| shipping.address | --- | Dados de endereço de cobrança Tipo: object |
| shipping.address.street | --- | Rua Tipo: string |
| shipping.address.street_number | --- | Número Tipo: string |
| shipping.address.zipcode | --- | CEP Tipo: string |
| shipping.address.country | --- | País. Deve seguir o padão ISO 3166-1 alpha-2 Tipo: string |
| shipping.address.state | --- | Estado Tipo: string |
| shipping.address.city | --- | Cidade Tipo: string |
| shipping.address.neighborhood | --- | Bairro Tipo: string |
| shipping.address.complementary | --- | Complemento. Não deve ser uma string vazia nem null. Tipo: string |
| items | --- | Itens comprados Tipo: array |
| item.id | --- | Número de identificação na loja Tipo: string |
| item.title | --- | Nome do item vendido Tipo: string |
| item.unit_price | --- | Valor unitário em centavos Tipo: integer |
| item.quantity | --- | Número de unidades vendidas Tipo: integer |
| item.tangible | --- | Caracteriza o produto como bem físico ou não. Por bem físico, entende-se produtos que devem ser enviados fisicamente ao comprador, como calçados, eletrônicos e brinquedos. Se for um bem físico deve conter true (sim), caso contrário, deve conter false (não) Tipo: string |
| headerText | Total 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 |
| paymentButtonText | Pagar | Define o texto do botão final de pagamento. Tipo: string |
| boletoDiscountPercentage | --- | Define a porcentagem de desconto no boleto. Tipo: number |
| 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: number |
| 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 |
Todos esses parâmetros adicionais são passados no momento que o checkout é aberto (checkout.open), segue exemplo:
<script>
checkout.open({
paymentButtonText: 'Finalizar',
amount: 10000,
maxInstallments: 12,
defaultInstallment: 1,
customerData: 'true',
createToken: 'true',
paymentMethods: 'boleto,credit_card',
uiColor: '#1ea51c',
boletoDiscountPercentage: 0,
boletoExpirationDate: '12/12/2020',
postbackUrl: "postback-cool.com",
items: [{
id: '1',
title: 'ItemZero',
unit_price: 10000,
quantity: 1,
tangible: 'false'
}]
});
</script>
Exemplo do Checkout
É possível testar os parâmetros que irá utilizar clicando aqui.
Updated almost 4 years ago