Cria pagamento
POST /payments
Cadastra um novo pagamento para análise
Corpo da requisição
payment object
Identifique o pagamento através de um código único que não se repete na mesma conta. Se não fornecido, um identificador aleatório será gerado.
Tipo do pagamento
purchase verifyStatus do pagamento. Consulte a documentação para mais detalhes sobre os status possíveis.
initiated succeeded declined failed blockedMoeda do pagamento de acordo com o padrão ISO 4217.
Valor com duas casas decimais. Utilize "." como separador decimal.
Data e hora em que o pagamento foi iniciado no formato ISO 8601. Se não for enviado, o horário atual será usado. O prazo máximo para envio retroativo (backfill) é 24 horas. Horários no futuro não são permitidos.
Método de pagamento. Preferencialmente, envie todas as informações disponíveis nesta requisição. Caso algum dado não esteja disponível nesta etapa do seu fluxo, é possível enviá-lo posteriormente através do mesmo parâmetro na operação de atualização.
method object
Tipo do método de pagamento.
credit_card debit_cardcard object
Bandeira
visa mastercard american_express diners_club elo hipercard jcb discover otherIndica se a transação foi realizada com cartão presente (CP) ou cartão não presente (CNP). Consulte a documentação sobre presença de cartões para mais informações.
card_present card_not_presentPrimeiros 8 números do PAN que identificam o emissor do cartão (conhecido também como IIN)
Últimos 4 números do PAN
Informações sobre o servidor externo que está enviando a requisição para sua API backend. Certifique-se que os dados enviados são do servidor remoto fora do seu perímetro de segurança, e não de servidores intermediários dentro da sua infraestrutura.
backend object
Endereço IPv4 ou IPv6 do servidor externo. Se este dado não estiver disponível, deixe o campo em branco. Endereços privados serão ignorados na análise.
Cabeçalhos HTTP enviados pelo servidor externo. Se possível, envie todos. Caso contrário, envie no mínimo `User-Agent`, `Accept`, `Accept-Encoding`, `Accept-Language` e `Host`. Cabeçalhos confidenciais usados para autenticação e sessão serão removidos automaticamente.
Informações sobre o dispositivo do usuário, caso o pagamento tenha sido realizado em ambiente online (web ou aplicativo). Não envie este bloco para tentativas iniciadas sem a interação direta do usuário (renovação da recorrência, por exemplo).
device object
Endereço IPv4 ou IPv6 do dispositivo do usuário. Se este dado não estiver disponível, deixe o campo em branco. Endereços privados serão recusados.
Cabeçalhos HTTP enviados pelo dispositivo do usuário na requisição. Se possível, envie todos. Caso contrário, envie no mínimo `User-Agent`, `Accept`, `Accept-Encoding`, `Accept-Language` e `Host`. Cabeçalhos confidenciais usados para autenticação e sessão serão removidos automaticamente.
Impressão digital do dispositivo do usuário.
fingerprint object
Código identificador único da impressão digital do dispositivo.
Fornecedor do serviço de coleta da impressão digital.
fingerprintjs basicInformações sobre o usuário que está efetuando o pagamento.
user object
Código identificador do usuário.
Email do usuário. Se desejar a análise sem dados pessoais, informe apenas o domínio (ex. `gmail.com`).
Informações sobre a compra.
order object
Código identificador opcional do pedido (ou compra, mensalidade, carrinho, etc). Retentativas de pagamento na mesma compra devem usar a mesma identificação para rastrear a quantidade de tentativas. Consulte a documentação para mais detalhes sobre o código do pedido.
Informações sobre o estabelecimento. Utilize este campo para informar a unidade de negócio, franquia ou empresa que está realizando a operação.
merchant object
Código identificador do estabelecimento que está realizando a operação.
País do estabelecimento de acordo com o formato ISO 3166-1 alfa-2 (2 caracteres).
Código de categoria da empresa (MCC) de acordo com o padrão ISO 18245.
Lista com as tentativas de transação para este pagamento. Obrigatório se o `status` do pagamento for `succeeded` ou `declined`. Recomendável para `failed` e `blocked` se houverem tentativas de transação.
transactions[] item
Código identificador único da transação. Consulte a documentação para mais detalhes sobre o código da transação.
Status de retorno da tentativa de transação. Consulte a documentação para mais detalhes sobre os status possíveis.
succeeded declined failedTempo de execução da transação em milissegundos (1 segundo = 1000 milissegundos).
Data e hora em que a transação foi iniciada no formato ISO 8601. Se não for enviado, o horário atual será usado. O prazo máximo para envio retroativo (backfill) é 24 horas. Horários no futuro não são permitidos.
Informações sobre o conector de pagamento utilizado na transação. O conector pode ser uma adquirente, um subadquirente ou um gateway.
connector object
Código da integração com o conector. Informe um código que represente um contrato de filiação ou uma conexão de integração específica. Recomendamos prefixar o código com o tipo do conector para facilitar consultas em relatórios.
Tipo do conector. Consulte a documentação para obter a lista completa.
Código de resposta alfanumérico da tentativa. Para cartão de crédito no Brasil, utilizar preferencialmente o padrão determinado pela normativa 21 da ABECS. Obrigatório se `transaction.status` for `succeeded` ou `declined`. Recomendável para `failed` quando presente.
Metadados adicionais. Para informações sobre requisitos e limites, consulte a documentação.
Habilita a análise do pagamento.
analyze object
Informe, opcionalmente, a regra a ser aplicada na recomendação de risco.
rule object
Nome da regra, conforme cadastrado previamente. Se a regra informada não existir ou se não possuir versão ativa publicada, a requisição não irá falhar e a recomendação de risco será fornecida de acordo com a configuração padrão da conta.
Detecta comportamento automatizado (robôs, scripts, etc)
Respostas
201Pagamento criado com sucesso
payment object
Código identificador do pagamento criado.
Status do pagamento.
Resultado das análises solicitadas.
analyses object
bot_behaviour object
Ação recomendada de acordo com o score de risco e a configuração no painel de adminstração.
allow challenge denyScore (pontuação de risco) no formato decimal entre `0.00` e `1.00` com duas casas decimais. Quanto mais próximo de 1, maior a probabilidade do pagamento ter sido realizado por um bot. Este é apenas um campo informativo. Recomendamos utilizar a recomendação do campo `action` para implementar a tomada de decisão. Para simular um score arbitrário na conta de testes, verifique a documentação.
401Credenciais de acesso inválidas
errors[] item
Campo da requisição onde ocorreu o erro
Código do tipo do erro
Mensagem do erro
422Parâmetros inválidos
errors[] item
Campo da requisição onde ocorreu o erro
Código do tipo do erro
Mensagem do erro
{
"payment": {
"id": "string",
"type": "purchase",
"status": "initiated",
"currency": "BRL",
"amount": 10.23,
"timestamp": "2024-01-01T00:00:00Z",
"method": {
"type": "credit_card",
"card": {
"network": null,
"presence": null,
"bin": null,
"last_four": null
}
},
"backend": {
"ip_address": "200.200.200.200",
"headers": {
"User-Agent": "Java-Http-Client/11.0",
"Accept": "application/json",
"EveryOtherHeader": "value"
}
},
"device": {
"ip_address": "200.200.200.200",
"headers": {
"User-Agent": "Chrome",
"Accept": "text/html,application/xhtml+xml",
"EveryOtherHeader": "value"
},
"fingerprint": {
"id": null,
"provider": null
}
},
"user": {
"id": "string",
"email": "teste@gmail.com"
},
"order": {
"id": "string"
},
"merchant": {
"id": "string",
"country": "BR",
"category_code": "7997"
},
"transactions": [
{
"id": null,
"status": null,
"duration": null,
"timestamp": null,
"connector": null
}
],
"metadata": {
"plano": "premium_1",
"categoria_do_cliente": "vip"
},
"analyze": {
"rule": {
"name": null
},
"bot_behaviour": false
}
}
}