Pular para o conteúdo principal

Pagamento com Anti-Fraude

Dados da API

API Gateway
Esta API é utilizada para operações do gateway de pagamento:

Introdução​

A operação de Pagamento com Anti-Fraude permite processar transações com maior segurança, utilizando a biblioteca antifraude da ENOQ. É essencial que a biblioteca antifraude esteja devidamente implementada em seu sistema antes de realizar essas operações. Para mais informações, consulte a seção de Biblioteca Antifraude nesta documentação.

Realizar Operação de Pagamento​

Para criar uma transação utilizando cartão de crédito, envie uma requisição POST para o endpoint /v1/payments com os dados necessários. O exemplo abaixo ilustra uma requisição típica.

POST /v1/payments

Via request Representational State Transfer (REST) com o body:

Requisição
  {
    "payment": {
      "transactionType": "string",
      "amount": 0,
      "productType": "string",
      "installments": 0
    },
    "referenceTransaction": "string",
    "urlCallBack": "string",
    "sellerInfo": {
      "codeAntiFraud": "string"
    },
    "customer": {
      "documentNumber": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "mobilePhoneNumber": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string",
      "ipAddress": "string",
      "country": "string"
    },
    "cardInfo": {
      "numberToken": "string",
      "vaultId": "string",
      "cardholderName": "string",
      "securityCode": "string",
      "brand": "string",
      "expirationMonth": "string",
      "expirationYear": "string",
      "encryptedCard": "string"
    },
    "configSplit": [
      {
        "documentNumberBeneficiary": "string",
        "percent": 0,
        "type": "string"
      }
    ]
  }

Dicionário de dados - Parâmetros​

PROPRIEDADEDESCRIÇÃOTIPOLOCALOBRIGATÓRIOTAMANHO
Payment.TransactionTypeTipo da transação.stringbodysimfixo
Payment.AmountValor do Pedido em centavos.integerbodysim10
Payment.ProductTypeTipo de produto – avista/ lojistastringbodysimfixo
Payment.InstallmentsNúmero de Parcelas.integerbodysim2
ReferenceTransactionReferência do pagamento enviada pelo integrador. Retornada na conciliação.stringbodynão50
UrlCallBackURL de callback do comércio para retorno do fluxo de pagamento.stringbodynão500
sellerInfo.codeAntiFraudCódigo obtido através da biblioteca anti-fraudeguidbodysim36
ConfigSplitLista de configurações de split de pagamento. Permite dividir o valor entre múltiplos beneficiáriosarraybodynão-
ConfigSplit[].documentNumberBeneficiaryCPF/CNPJ do beneficiário do split de pagamento (sem máscara)stringbodynão14
ConfigSplit[].percentPorcentagem do split de pagamento (0-100)decimalbodynão5,2
ConfigSplit[].typeTipo de split: 'bruto' (sobre valor bruto) ou 'liquido' (após taxas)stringbodynão10
CardInfo.NumberTokenIdentificador do cartão tokenizado.stringbodysimfixo
CardInfo.VaultIdIdentificador do cartão salvo no cofre.stringbodynão36
CardInfo.CardholderNameNome do comprador impresso no cartão.stringbodysim30
CardInfo.SecurityCodeCódigo de segurançastringbodysim4
CardInfo.BrandBandeira do cartão – Opcional.stringbodynãofixo
CardInfo.ExpirationMonthMês de expiração do cartão com dois dígitos.stringbodysim2
CardInfo.ExpirationYearAno de expiração do cartão com dois dígitos.stringbodysim2
CardInfo.EncryptedCardDados do cartão criptografados com a chave pública RSA obtida em /cards/public-key. Utilizado como alternativa segura ao envio dos dados de cartão em texto puro.stringbodynão2048
Customer.DocumentTypeTipo de documento do compradorstringbodysim4
Customer.DocumentNumberNúmero do documento do compradorstringbodysim20
Customer.FirstNamePrimeiro nome do compradorstringbodysim50
Customer.LastNameÚltimo nome do comprador.stringbodysim60
Customer.EmailE-mail do compradorstringbodysim255
Customer.PhoneNumberTelefone do compradorstringbodysim15
Customer.MobilePhoneNumberTelefone celular do compradorstringbodysim25
Customer.AddressEndereço do compradorstringbodysim60
Customer.ComplementComplemento do endereço do compradorstringbodynão60
Customer.CityCidade do compradorstringbodysim50
Customer.StateEstado do compradorstringbodysim2
Customer.ZipCodeCEP compradorstringbodysim10
Customer.IpAddressEndereço IP do dispositivo do compradorstringbodysim48
Customer.CountryPaís do compradorstringbodysim2
Observação

Vendas parceladas: Para vendas parceladas, utilize o productType como lojista. Para vendas à vista (parcela única), utilize avista.

Domínios​

PROPRIEDADECONTEÚDO
Payment.TransactionTypecredit
Payment.ProductTypeavista, lojista
CardInfo.Brandvisa, mastercard, amex, elo, hipercard
Customer.DocumentTypecpf, cnpj
Erro interno
[
  {
    "tag": "",
    "description": "Não foi possível executar comando. Erro desconhecido."
  }
]

Consulte também​

Códigos de Resposta

Para identificar e tratar adequadamente os códigos de erro retornados nas transações, consulte nossa tabela completa:

Códigos de Resposta do Host →