# Botão de Pagamentos
Através dos botões de pagamento da IOPAY você pode integrar o seu website ou loja em minutos, através de um código HTML simples que deve ser inserido na sua página.
O botão de pagamentos da IO permite que você obtenha uma integração simples, rápida e segura. A página de pagamento customizada com o seu logo será aberta de forma segura e automática dentro do seu site, garantindo maior conversão das vendas.
Todas as nossas integrações estão em conformidade com as entidades reguladoras de meios de pagamento e seguem o mais alto grau de segurança desse mercado.
Através do botão de pagamento da IOPAY você será capaz de receber pagamentos nas seguintes modalidades:
O guia abaixo lhe orientará sobre aspectos importantes e como integrar o botão de pagamento IOPAY em seu projeto.
## Setup
Para utilizar o botão de pagamento da IOPAY você deve:
1. **Possuir uma conta de vendedor na IOPAY** ([saiba como obter](https://onboarding.iopay.com.br/register)).
2. **Habilitar a sua conta para recebimento por botões de pagamento** (entre em contato com ). Você receberá informações extras como o ***io\_seller\_id**.*
3. Inserir o `
```
{% endtab %}
{% tab title="Ambiente de Produção" %}
```html
```
{% endtab %}
{% endtabs %}
{% hint style="info" %}
Repare que a única mudança para diferenciar o ambiente de produção e testes (sandbox) é o prefixo da URI utilizada:\
\
**sandbox.checkout.iopay.dev** \[testes]
**checkout.iopay.dev** \[produção]
{% endhint %}
{% hint style="success" %}
Você pode utilizar um **botão com estilos CSS personalizados**, contudo lembre-se de inseri-lo dentro do form e adicionar o atributo **`onclick="iopay()"`**, conforme demonstrado ac
{% endhint %}
## Parâmetros
Abaixo relação de parâmetros esperados pelo formulário.\
Cada pagamento pode conter um ou mais itens, que representam produtos ou serviços que estão sendo vendidos.
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| ----------------- | -------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`integration`** | Esse parâmetro especifica qual o tipo de integração em uso. Valor aceito para botão de pagamentos: **`transparent`** | Sim |
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| -------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`business`** | Identifica a conta de vendedor cadastrada na IOPAY. Este parâmetro deve ser do tipo email, exemplo: **`john@example.com`** | Sim |
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`reference_id`** |
Neste parâmetro você pode informar o identificador único do pedido da sua loja, como por exemplo o ID do pedido atual. Este campo pode conter uma cadeia de até 64 caracteres. Exemplo de reference\_id: 1234 Ao informar esse parâmetro, você pode usá-lo para recuperar posteriormente o status desse pagamento (aprovado, cancelado, rejeitado etc) e atualizar na sua base de pedidos.
Este parâmetro é utilizado para informar os nomes dos itens que estão sendo vendidos.
Para adicionar mais de um item, basta inserir mais um parâmetro product\_name\[], conforme o exemplo abaixo:
| Sim |
```markup
...etc
```
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`product_number[]`** | Utilize esse parâmetro para informar o identificador único desse produto ou serviço na sua loja ou site, conforme o exemplo abaixo: | Não |
```markup
...etc
```
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`product_amount[]`** |
Parâmetro utilizado para informar o preço individual de cada produto ou serviço comercializado, Este parâmetro aceita valores numéricos do tipo float. Dessa forma, para informar o valor de R$199,00 deve-se informar 199.00 conforme o exemplo:
| Sim |
```markup
...etc
```
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`product_quantity[]`** | Parâmetro utilizado para informar a quantidade de cada produto comercializado. Apenas números inteiros são aceitos. O exemplo abaixo indica que o cliente está adquirindo 3 Produto 1 e 1 Produto 2. | Sim |
```markup
...etc
```
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
| **`product_weight[]`** |
Esse parâmetro é utilizado para informar o peso individual de determinado produto.
O valor desse parâmetro é baseado no tipo numérico float representado em Kg, ou seja, para informar 200g, use: 0.2
| Não |
```markup
...etc
```
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`currency_code`** | Define a moeda utilizada nessa venda. Até o momento o único valor aceito pela IO para esse parâmetro é **`BRL`** que representa o Real Brasileiro**.** | Não |
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`first_name`** | Este campo é opcional e representa o primeiro nome do cliente que iniciou a compra. Você pode usá-lo para enviar o nome do cliente, evitando assim que o cliente precise preencher novamente ao acessar o formulário de pagamento | Não |
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`last_name`** | Este campo é opcional e representa o último nome/sobrenome do cliente que iniciou a compra. Ao usar esse parâmetro na sua integração você melhor a experiência de compra do seu cliente, evitando assim que o cliente precise preencher novamente ao acessar o formulário de pagamento | Não |
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`cpf`** |
Este campo é opcional e representa o CPF do cliente que iniciou a compra. Ao usar esse parâmetro na sua integração você melhora a experiência de compra do seu cliente, evitando assim que o cliente precise preencher novamente ao acessar o formulário de pagamento
Este parâmetro permite que você envie o CPF com pontos e traços, conforme o padrão: XXX.XXX.XXX-XX
Este parâmetro é utilizado para informar o número de telefone com DDD do seu cliente. Ao usar esse parâmetro na sua integração você melhor a experiência de compra do seu cliente, evitando assim que o cliente precise preencher novamente ao acessar o formulário de pagamento
Este parâmetro permite que você envie o DDD entre parêntesis, conforme o padrão: (XX)XXXXX-XXXX O valor pode ser composto de um número de celular com DDD ou número de telefone fixo com DDD
Utilize esse parâmetro para informar a primeira linha do endereço do cliente. Exemplo: Rua da Consolação
Ao usar esse parâmetro na sua integração você melhora a experiência de compra do seu cliente, evitando assim que o cliente precise preencher novamente ao acessar o formulário de pagamento
Utilize esse parâmetro para informar o número do endereço do seu cliente. Exemplo: 750
Ao usar esse parâmetro na sua integração você melhor a experiência de compra do seu cliente, evitando assim que o cliente precise preencher novamente ao acessar o formulário de pagamento
Utilize esse parâmetro para informar o complemento do endereço do seu cliente. Exemplo: Fundos, Casa 2
Ao usar esse parâmetro na sua integração você melhor a experiência de compra do seu cliente, evitando assim que o cliente precise preencher novamente ao acessar o formulário de pagamento
Utilize esse parâmetro para informar a cidade à partir do endereço do seu cliente. Exemplo: São Paulo
Ao usar esse parâmetro na sua integração você melhor a experiência de compra do seu cliente, evitando assim que o cliente precise preencher novamente ao acessar o formulário de pagamento
Utilize esse parâmetro para informar a unidade federativa/estado a partir do endereço do seu cliente.
Ao usar esse parâmetro na sua integração você melhor a experiência de compra do seu cliente, evitando assim que o cliente precise preencher novamente ao acessar o formulário de pagamento
Esse parâmetro deve ser composto pela sigla do estado com 2 letras. Exemplo: SP
Se informado, esse parâmetro é utilizado para fornecer o endereço completo no formulário de pagamento, evitando assim que o seu cliente precise preencher todos os campos
Parâmetro utilizado para informar o e-mail do cliente comprador. Ao integrar e enviar esse parâmetro (opcional), você melhora a experiência de compra do seu cliente, pois o valor desse campo virá preenchido no formulário de pagamento.
O formato de dados aceito segue o padrão e-mail, por exemplo
Este parâmetro, se usado, informa a descrição da compra na fatura do cliente. Você pode usá-lo para facilitar a identificação pelo seu cliente da compra efetuada na fatura do cartão. Exemplo de uso: Loja de Sapatos XYZ (lojadesapatosxyz.com)
Este parâmetro define a URL da sua loja, que será usada para redirecionar o seu cliente após sucesso na geração do pagamento Exemplo de uso:
A URL receberá parâmetros GET informando o ID da Transação (transaction\_id) e o Status (status), o usuário será redirecionado ao Fechar a tela de pagamento. Exemplo:
?transaction\_id=xx\&status=pending
ATENÇÃO: Não utilize essa rota para confirmar o pagamento na sua base de dados. Para confirmação utilize o serviço de WebHooks da IOPAY.
| Não |
Possíveis '**status**' retornados na URL:
* **pending** : pendente, comum para pagamentos por boleto
* **succeeded** : pago com sucesso
* **pre\_authorized** : apenas pré-autorizado, ainda estão em análise antifraude
| PARÂMETRO | DESCRIÇÃO | OBRIGATÓRIO |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **`amount`** |
Parâmetro obrigatório, utilizado para informar o montante total dessa venda através de um tipo numérico float. Por exemplo, se a somatória de preços dos produtos + custo de frete para envio é de R$485,70, deve-se utilizar 485.70
| Sim |
## Antifraude
Para prevenir ações suspeitas de fraude, insira o script de monitoramento do comportamento do usuário no rodapé do seu site.
Ao inserir esse trecho de código estaremos monitorando o comportamento do usuário em seu site; É altamente recomendável que este script seja carregado globalmente (em todo site).
{% tabs %}
{% tab title="Ambiente de testes (Sandbox)" %}
```markup
```
{% endtab %}
{% tab title="Ambiente de Produção" %}
```markup
```
{% endtab %}
{% endtabs %}
{% hint style="success" %}
**Não se preocupe com o desempenho da sua página**
Este será o ultimo script a ser carregado em sua página, sem afetar a performance e experiência do usuário; Para que isso ocorra, recomendamos que este script seja inserido, globalmente, antes do fechamento da tag \
ou \ no corpo do site.
{% endhint %}
{% hint style="warning" %}
**Não faça nenhuma alteração na estrutura deste script**
Este script foi cuidadosamente desenvolvido para monitorar as ações do usuário, e lhe proteger de possíveis fraudes, sem afetar o desempenho do seu site. Não altere a estrutura do script, apenas atribua os valores necessários para configura-lo (Vide o tópico abaixo **"Configure o script de monitoramento**")
{% endhint %}
### **Configure o script de monitoramento**
As informações solicitadas para configuração do script de monitoramento podem ser obtidas na sua [Conta Digital](https://minhaconta.iopay.com.br/) em: **Conta Digital > Pagamentos Online**
|