API ReferenceSiteBlogSuporteAPI StatusChangelogPainel

Fcontrol.old

Suggest Edits

O FRAME é um produto simples, fácil de ser integrado e atrativo financeiramente para as lojas com baixo volume de transações mensais. Com ele, você terá a melhor ferramenta de detecção de fraude, baseada no modelo estatístico mais atualizado do mercado, que é utilizado e desenvolvido para os maiores varejistas do Brasil.

📘

ATENÇÃO: Válido apenas para transações de autorizações e venda direta.

  • Apenas para cartões de crédito.
TAGRequisitoTamanho / LimiteDescrição
versionO[3...5]Versão do xml para verificação de versionamento.
merchantIdO[1...10]Número de afiliação da loja com o AZPAY.
merchantKeyO[10...50]Token de acesso, pode ser alterado via painel de controle.
referenceO[1...16]Número de referência de um produto, pedido, serviço, etc. Identificação dentro do AZPAY.
totalAmountO[3...12]]Valor total a ser processado. R$1,00 = 100.
acquirerO[1...9]ID de identificação do operador, verificar tabela de operadores.
methodO[1...9]ID de identificação da operação, verificar tabela de operações.
amountO[3...12]Valor da operação, (já deve incluir valores de frete, embrulho, custos extras, taxa de embarque, etc). Esse valor é o que será debitado do consumidor.
currencyO[0...0]Código numérico da moeda na norma ISO 4217. Para o Real, o código é 986.
countryO[0...0]Origem do pedido: BRA (Brasil). Caso não seja enviado, o sistema assumirá BRA.
numberOfPaymentsO[1...2]Número de parcelas. Para crédito à vista ou débito, utilizar “1”.
groupNumberO[0...0]Verificar.
flagO[0...0]Nome da bandeira (minúsculo):
“visa” “mastercard” “diners” “discover” “elo” “amex” “jcb” “aura”.
cardHolderO[1...25]Nome impresso no cartão.
cardNumberO[12...19]Número do cartão de crédito.
cardSecurityCodeO[3...4]Número do código de segurança.
cardExpirationDateO[0...0]Validade do cartão no formato aaaamm. Exemplo: 202010 (out/2020).
saveCreditCardO[true ou false]Permitir salvar o cartão truncado na base para consulta.
generateTokenO[true ou false]Gerar token de acesso.
departureTaxN[1...10]Taxa de embarque. (verificar disponibilidade)
softDescriptorN[1...13]Descrição na fatura do cartão de crédito. (verificar disponibilidade)
customerIdentityN[1..30]Número de identificação único do cliente.
nameN[0...30]Nome do cliente.
addressN[0...255]Endereço do cliente.
address2N[0...255]Complemento do cliente.
cityN[0...255]Cidade do cliente.
stateN[0...255]Estado do cliente.
postalCodeN[0...255]CEP, código postal do cliente.
countryN[0...255]País do cliente.
phoneN[0...45]Telefone do cliente.
emailN[0...145]E-mail do cliente.
urlReturnO[0...255]URL de retorno que receberá um POST depois de cada alteração de status da transação.
fraudO[true ou false]Sistema de anti-fraude. (verificar disponibilidade)
fraudData.operatorO[0...45]"clearsale","fcontrol" ou "konduto" .
fraudData.methodO[0...45]"frame","frame","score".
fraudData.costumerIPO[0...45]Ip do comprador.
fraudData.deviceN[0...255]Hash do dispositivo gerado pelo javascript instalado no site. (Somente Konduto obrigatório)
fraudData.nameO[0...45]Nome completo do comprador.
fraudData.documentO[0...45]CPF ou RG.
fraudData.phonePrefixO[0...45]DDD do telefone.
fraudData.phoneNumberO[0...45]Número do telefone.
fraudData.addressO[0...45]Endereço do comprador.
fraudData.addressNumberO[0...45]Número do endereço do comprador.
fraudData.address2N[0...45]Complemento do endereço caso exista.
fraudData.cityO[0...45]Cidade onde mora o comprador.
fraudData.stateO[2...2]UF do estado do comprador.
fraudData.postalCodeO[0...45]CEP do comprador.
fraudData.countryO[2...3]Sigla do País.
fraudData.emailO[1...145]E-mail do comprador.
fraudData.itensODescrição de todos os itens de venda.
fraudData.itens.item.productNameO[1...145]Nome do produto adquirido pelo comprador.
fraudData.itens.item.quantityO[1...2]Quantidade do produto adquirido pelo comprador.
fraudData.itens.item.priceO[1...5]Preço do produto adquirido pelo comprador sem casas decimais R$100,00 = 10000.
customFieldN[0...255]Campos para uso diverso.
LegendaDescrição
NNão-obrigatório
ODado obrigatório

📘

O valor do resultante da divisão do valor do pedido pelo número de parcelas não deve ser inferior a R$5,00. Caso contrário a transação será negada.

🚧

ATENÇÃO: Uma transação autorizada somente gera o crédito para o lojista se ela for capturada (ou confirmada).

Exemplo de como o FControl com autorização:

{
  "transaction-request": {
    "version": "1.0.0",
    "verification": {
      "merchantId": "1",
      "merchantKey": "xl4fgdwt6ukutyb99772555939853191"
    },
    "authorize": {
      "order": {
        "reference": "988AFE455281C31A",
        "totalAmount": "10000"
      },
      "payment": {
        "acquirer": "1",
        "method": "2",
        "amount": "10000",
        "currency": "986",
        "country": "BRA",
        "numberOfPayments": "3",
        "groupNumber": "0",
        "flag": "visa",
        "cardHolder": "Jose da Silva",
        "cardNumber": "5453010000066100",
        "cardSecurityCode": "123",
        "cardExpirationDate": "202010",
        "saveCreditCard": "true",
        "generateToken": "false",
        "departureTax": "0"
      },
      "billing": {
        "customerIdentity": "1",
        "name": "Fulano de Tal",
        "address": "Av. República do Brasil, 1988",
        "address2": "16 Andar",
        "city": "São Paulo",
        "state": "SP",
        "postalCode": "08742000",
        "country": "BR",
        "phone": "123456789",
        "email": "[email protected]"
      },
      "urlReturn": "https://seusite.com.br/retorno",
      "fraud": "true",
      "fraudData": {
        "operator": "clearsale",
        "method": "start",
        "costumerIP": "111.222.333.444",
        "name": "Fulano de Tal",
        "document": "23233",
        "phonePrefix": "11",
        "phoneNumber": "123456789",
        "address": "Av. República do Brasil",
        "addressNumber": "1988",
        "address2": "condominio central",
        "city": "São Paulo",
        "state": "SP",
        "postalCode": "08742000",
        "country": "BR",
        "email": "[email protected]",
        "itens": {
          "item": [
            {
              "productName": "Iphone Xs - 256GB",
              "quantity": "1",
              "price": "1000000"
            },
            {
              "productName": "Iphone Xs - 64GB",
              "quantity": "1",
              "price": "900000"
            }
          ]
        }
      }
    }
  }
}

<transaction-request>
    <version>1.0.0</version>
    <verification>
        <merchantId>1</merchantId>
        <merchantKey>xl4fgdwt6ukutyb99772555939853191</merchantKey>
    </verification>
    <authorize>
        <order>
            <reference>988AFE455281C31A</reference>
            <totalAmount>10000</totalAmount>
        </order>
        <payment>
            <acquirer>1</acquirer>
            <method>2</method>
            <amount>10000</amount>
            <currency>986</currency>
            <country>BRA</country>
            <numberOfPayments>3</numberOfPayments>
            <groupNumber>0</groupNumber>
            <flag>visa</flag>
            <cardHolder>Jose da Silva</cardHolder>
            <cardNumber>5453010000066100</cardNumber>
            <cardSecurityCode>123</cardSecurityCode>
            <cardExpirationDate>202010</cardExpirationDate>
            <saveCreditCard>true</saveCreditCard>
            <generateToken>false</generateToken>
            <departureTax>0</departureTax>
            <softDescriptor></softDescriptor>
        </payment>
        <billing>
            <customerIdentity>1</customerIdentity>
            <name>Fulano de Tal</name>
            <address>Av. República do Brasil, 1988</address>
            <address2>16 Andar</address2>
            <city>São Paulo</city>
            <state>SP</state>
            <postalCode>08742000</postalCode>
            <country>BR</country>
            <phone>123456789</phone>
            <email>[email protected]</email>
        </billing>
         <urlReturn>https://seusite.com.br/retorno</urlReturn>
        <fraud>true</fraud>
        <fraudData>
            <operator>fcontrol</operator>
            <method>frame</method>
            <costumerIP>192.222.333.23</costumerIP>
            <name>Fulano de Tal</name>
            <document>23233</document>
            <phonePrefix>11</phonePrefix>
            <phoneNumber>123456789</phoneNumber>
            <address>Av. República do Brasil</address>
            <addressNumber>1988</addressNumber>
            <address2>condominio central</address2>
            <city>São Paulo</city>
            <state>SP</state>
            <postalCode>08742000</postalCode>
            <country>BR</country>
            <email>[email protected]</email>
            <itens>
                <item>
                    <productName>Iphone Xs - 256GB</productName>
                    <quantity>1</quantity>
                    <price>1000000</price>
                </item>
                <item>
                    <productName>Iphone Xs - 64GB</productName>
                    <quantity>1</quantity>
                    <price>900000</price>
        </fraudData>
        <customField/>>Exemplo de como o FControl com autorização.
    </authorize>
</transaction-request>

Exemplo de como usar FControl com venda direta:

{
  "transaction-request": {
    "version": "1.0.0",
    "verification": {
      "merchantId": "1",
      "merchantKey": "xl4fgdwt6ukutyb99772555939853191"
    },
    "sale": {
      "order": {
        "reference": "988AFE455281C31A",
        "totalAmount": "10000"
      },
      "payment": {
        "acquirer": "1",
        "method": "2",
        "amount": "10000",
        "currency": "986",
        "country": "BRA",
        "numberOfPayments": "3",
        "groupNumber": "0",
        "flag": "visa",
        "cardHolder": "Jose da Silva",
        "cardNumber": "5453010000066100",
        "cardSecurityCode": "123",
        "cardExpirationDate": "202010",
        "saveCreditCard": "true",
        "generateToken": "false",
        "departureTax": "0"
      },
      "billing": {
        "customerIdentity": "1",
        "name": "Fulano de Tal",
        "address": "Av. República do Brasil, 1988",
        "address2": "16 Andar",
        "city": "São Paulo",
        "state": "SP",
        "postalCode": "08742000",
        "country": "BR",
        "phone": "123456789",
        "email": "[email protected]"
      },
      "urlReturn": "https://seusite.com.br/retorno",
      "fraud": "true",
      "fraudData": {
        "operator": "clearsale",
        "method": "start",
        "costumerIP": "111.222.333.222",
        "device:": "",
        "name": "Fulano de Tal",
        "document": "23233",
        "phonePrefix": "11",
        "phoneNumber": "123456789",
        "address": "Av. República do Brasil",
        "addressNumber": "1988",
        "address2": "condominio central",
        "city": "São Paulo",
        "state": "SP",
        "postalCode": "08742000",
        "country": "BR",
        "email": "[email protected]",
        "itens": {
          "item": [
            {
              "productName": "Iphone Xs - 256GB",
              "quantity": "1",
              "price": "1000000"
            },
            {
              "productName": "Iphone Xs - 64GB",
              "quantity": "1",
              "price": "900000"
            }
          ],
          "#text": "..."
        }
      }
    }
  }
}

<transaction-request>
    <version>1.0.0</version>
    <verification>
        <merchantId>1</merchantId>
        <merchantKey>xl4fgdwt6ukutyb99772555939853191</merchantKey>
    </verification>
    <sale>
        <order>
            <reference>988AFE455281C31A</reference>
            <totalAmount>10000</totalAmount>
        </order>
        <payment>
            <acquirer>1</acquirer>
            <method>2</method>
            <amount>10000</amount>
            <currency>986</currency>
            <country>BRA</country>
            <numberOfPayments>3</numberOfPayments>
            <groupNumber>0</groupNumber>
            <flag>visa</flag>
            <cardHolder>Jose da Silva</cardHolder>
            <cardNumber>5453010000066100</cardNumber>
            <cardSecurityCode>123</cardSecurityCode>
            <cardExpirationDate>202010</cardExpirationDate>
            <saveCreditCard>true</saveCreditCard>
            <generateToken>false</generateToken>
            <departureTax>0</departureTax>
            <softDescriptor></softDescriptor>
        </payment>
        <billing>
            <customerIdentity>1</customerIdentity>
            <name>Fulano de Tal</name>
            <address>Av. República do Brasil, 1988</address>
            <address2>16 Andar</address2>
            <city>São Paulo</city>
            <state>SP</state>
            <postalCode>08742000</postalCode>
            <country>BR</country>
            <phone>123456789</phone>
            <email>[email protected]</email>
        </billing>
         <urlReturn>https://seusite.com.br/retorno</urlReturn>
        <fraud>true</fraud>
        <fraudData>
            <operator>fcontrol</operator>
            <method>frame</method>
            <costumerIP>111.222.12.123</costumerIP>
            <name>Fulano de Tal</name>
            <document>23233</document>
            <phonePrefix>11</phonePrefix>
            <phoneNumber>123456789</phoneNumber>
            <address>Av. República do Brasil</address>
            <addressNumber>1988</addressNumber>
            <address2>condominio central</address2>
            <city>São Paulo</city>
            <state>SP</state>
            <postalCode>08742000</postalCode>
            <country>BR</country>
            <email>[email protected]</email>
            <itens>
                <item>
                    <productName>Iphone Xs - 256GB</productName>
                    <quantity>1</quantity>
                    <price>1000000</price>
                </item>
                <item>
                    <productName>Iphone Xs - 64GB</productName>
                    <quantity>1</quantity>
                    <price>900000</price>
                </item>...</itens>
        </fraudData>
        <customField/>
    </sale>
</transaction-request>

Updated over 5 years ago