API Reference
Log In
API Reference

Autorizar venda via web

Esta rota tem como objetivo realizar a autorização ou pré-autorização e captura de uma venda através de um canal Web utilizando os dados do cartão de crédito - i.e. Websites, E-Commerces, entre outros.

Log in to see full request history

📘

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​

VariávelTipoDescrição
createdAtStringData de criação da transação
statusStringStatus da transação
localCodeStringCódigo único interno do sistema para identificar uma transação
authorizationCodeStringCódigo de autorização da transação
nsuCodeStringCódigo complementar ao de autorização da transação
gatewayIdentifierStringIdentificador no gateway da transação
gatewayOrderStringIdentificador do pedido no gateway da transação
valueCentsBigIntegerValor da transação em centavos
installmentsIntQuantidade de parcelas
acquirerMessageStringResposta da transação pela adquirente

👍

Como faço para aprovar minhas vendas no ambiente de teste?

Utilizamos o número do cartão de crédito como identidade para autorizar uma venda realizada no ambiente de teste, ou seja, se você usar qualquer um dos cartões abaixo em sua requisição, a venda será Não Autorizada / Negada.

Dados do cartãoBandeiraRetorno esperado
N: 4929291898380766
CVV: 123 | EXP: 12/2026
VisaNegado.
N: 5530062640663264
CVV: 123 | EXP: 12/2026
MasterNegado
N: 372938001199778
CVV: 1234 | EXP: 12/2026
AmexNegado

Qualquer outro cartão diferente será Autorizado pela processadora de vendas da Justa.

👍

Valor total da venda em centavos e com valor mínimo.

O campo totalValue tem seus números contados em centavos, isso significa que o valor 500 equivale à R$5,00 (Cinco reais).

Nosso sistema permite pagamentos com parcelas (installments) de no mínimo R$5,00, ou seja, se a venda for com 2 parcelas, o totalValue deverá ter no mínimo R$10,00 para que cada parcela tenha no mínimo R$5,00 e assim por diante.

📘

Sobre vendas pré-autorizadas.

  • A pré-autorização para 29 dias está disponíveis para cartão de crédito nas bandeiras Elo, Visa e Mastercard em lojistas que estejam dentro das categorias de atuação elegíveis, lista disponível aqui.
  • Ao pré-autorizar uma cobrança a mesma ficará disponível para captura de 6 até 29 dias corridos. Ou seja, caso não haja solicitação de captura, haverá o cancelamento da cobrança automaticamente após a data limite para captura
  • Não está disponível a captura parcial da pré-autorização para a bandeira American Express.
  • A captura da pré-autorização poderá ser feita apenas se a cobrança estiver com status autorizada.

📘

Sobre o antifraude das vendas.

Para que haja a separação do seu estabelecimento no antifraude e consigamos adaptar as regras do motor de risco, se faz necessário que o parâmetro integradorID seja enviado, obrigatoriamente, no cabeçalho da requisição.

Outro fato importante é que, toda vez que uma venda não for autorizada e o código de erro for JST-99 ou JST-98, o grande fator que não autorizou foi o motor de risco. Em casos que o cliente pagador do estabelecimento for alguém de baixo risco - na visão de vocês -, o time de suporte pode ser acionado para calibragem do motor para que uma nova retentativa seja realizada.

❗️

Erros mapeados

Para visualizar os possíveis erros nesta API, acesse a Tabela de erros do pagamento web.

Body Params
string
required
Defaults to {id}

Identificador numérico da transação Obs.: A ser gerado e enviado pelo integrador para mapeamento interno.

string
required
Defaults to {order}

Número de identificação do pedido de pagamento Obs.: A ser gerado e enviado pelo integrador para mapeamento interno

string
required
Defaults to {reference}

Valor único de referência da transação Obs.: A ser gerado e enviado pelo integrador para mapeamento interno

string
required
Defaults to {ipAddress}

IP do cliente que está efetuando o pagamento

string
required
Defaults to {totalValue}

Valor total da transação com os descontos aplicados. O valor do campo é em centavos. Ex.: 500 equivalem à R$5,00.

string
required
Defaults to {discountValue}

Valor total dos descontos a serem aplicados

string
required
Defaults to {YYYY-MM-DD}

Data da transação Obs.: No formato yyyy-MM-dd

customer
object
required

Dados do comprador

string

Categoria da transação Obs.: Para modalidades Business to Client, enviar B2C, e para Business to Business enviar B2B

string

Moeda da transação Obs.: Para transações em Reais, enviar BRL

string
required
Defaults to {type}

Tipo da transação Obs.: Para transações com cartão de crédito, enviar CREDIT_CARD. Para transações com hash do cartão, enviar CREDIT_CARD_HASH.

string
required
Defaults to {saleType}

Tipo da transação Obs.: Para transações web avulsas, usar CREDIT

string

Id da sessão do usuário para ser enviada ao serviço de antifraude

creditCard
object

Dados do cartão de crédito do cliente (Obrigatório se não enviar o parâmetro cardHash).

boolean
Defaults to false

Flag para retornar o cartão tokenizado.

string

Cartão tokenizado (Obrigatório se não enviar o parâmetro creditCard).

string
Defaults to VISA

Nome da bandeira do cartão tokenizado. As bandeiras atualmente aceitas são VISA, MASTER, AMEX, HIPER, ELO, CABAL e devem ser informadas em caixa alta. (Obrigatório se não enviar o parâmetro creditCard)

string
required
Defaults to {installments}

Número de parcelas da transação

string
required
Defaults to {description}

Descrição da transação

double

Fator percentual a ser descontado da transação e repassado ao Integrador, mediamente a acordo prévio com a Justa. Obs.: O valor deve ser informado em fator percentual, por exemplo: 2.56% deve ser informado como 0.0256

boolean
Defaults to true

Com o valor false, será enviada como sendo uma venda pré-aprovada, necessitando de uma confirmação de pagamento em até cinco dias, ou será cancelada automaticamente. Se não atribuir nenhum valor, assume o valor true, e envia o pagamento normalmente

Headers
string
required
Defaults to Bearer {access_token}

Bearer token para autenticação na aplicação

string
required
Defaults to {client-token}

Token que irá identificar o estabelecimento. Este Token é recebido via webhook e é fixo para cada lojista

string
Defaults to application/json

Tipo do corpo da requisição a ser enviado

string

ID do integrador. Esse ID será provido pelo técnico responsável por acompanhar a integração e deverá ser enviaso para haver a separação de lojas no antifraude

Response

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json