Este endpoint tem como objetivo realizar o pagamento de um boleto com cartão de crédito
INFO
Obs.: Nenhum dado sensível enviado (dados do cartão de crédito) na requisição será salvo no banco de dados do Gateway para manter a conformidade com a LGPD!
Além disso, essa venda será considerada como uma venda não-presencial, ou seja, haverá um risco maior de ocorrer chargeback.
Observação importante
Para um bom funcionamento e assertividade nas análises de fraude, recomendamos as implementações dos scripts client-side descritos em nossa documentação, que podem ser encontrados clicando aqui.
Respostas das requisições
Você receberá na resposta da requisição a mensagem de retorno do pagamento do boleto com cartão, o status e todos os dados do boleto que foi registrado.
As variáveis que a resposta informa são:
| Variável | Tipo | Descrição |
|---|---|---|
| message | String | Mensagem de sucesso ou insucesso no pagamento do boleto com cartão |
| status | String | Status de pagamento do boleto com cartão |
| data | Object | Dados do boleto pago que foi registrado |
Recibos de pagamento
O campo paymentReceipt que está contido dentro do objeto "data" retorna detalhes apenas de boletos de concessionária e, futuramente, de tributos. Caso contrário, retorna vazio ou nulo.
Além disto, os campos são fixos, mas suas informações variam de acordo com o tipo do boleto. Exemplo, um boleto de IPVA pode retornar algo parecido como:
{ "title": "PLACA",
"description": "Placa",
"value": "ABC1A23"}
PaymentReceipt:
| Variável | Tipo | Descrição |
|---|---|---|
| title | String | Título, se disponível, do detalhe recebido do pagamento |
| description | String | Descrição, se disponível, do detalhe recebido do pagamento |
| value | String | Valor, se disponível, do detalhe recebido do pagamento |
Tipos de status de pagamento
Os tipos de status do pagamento que podem ser são:
| Tipo | Descrição |
|---|---|
| AUTHORIZED | Pagamento autorizado |
| NOT_AUTHORIZED | Pagamento não autorizado |
| ERROR | Houve um erro no processamento |
Tipos de gêneros do cliente
Os tipos de gêneros do cliente que podem ser são:
| Tipo | Descrição |
|---|---|
| MALE | Gênero masculino |
| FEMALE | Gênero feminino |
| OTHER | Outro |
Tipos de endereço
Os tipos de endereço que podem ser são:
| Tipo | Descrição |
|---|---|
| COMERCIAL | Endereço comercial |
| RESIDENTIAL | Endereço residencial |
Tipos de bandeira de cartão
Os tipos de bandeiras que podem ser são:
| Tipo | Descrição |
|---|---|
| MASTER | Bandeira Mastercard |
| VISA | Bandeira Visa |
| ELO | Bandeira Elo |
| HIPERCARD | Bandeira Hipercard |
| AMEX | Bandeira American Express |
| CABAL | Bandeira Cabal |
Erros mapeados
Para visualizar os possíveis erros nesta API, acesse a tabela de erros no pagamento de boleto com cartão.
totalValue
O campo totalValue, assim como é dita na sua descrição, deve ser o valor total do boleto com a taxa incluída. É recomendado requisitar o endpoint Simula valor de parcelas no pagamento de boleto com cartão para obter o valor com a taxa e repassar o custo já corrigido neste campo.