Create Transaction

To initiate a new transaction with the Tutelar Server, the following steps must be adhered to for proper setup and execution:

Whitelist Server IP Address: Before initiating the transaction process, ensure that your server’s IP address is whitelisted in the Tutelar Panel. This step is crucial as it authorizes your server to communicate with the Tutelar Server.

Generate API Keys: Generate the necessary API keys from the Tutelar Panel. These keys will be used to authenticate your API requests to the Tutelar Server, ensuring secure and verified communication.

Submit Transaction via Create Transaction API: Utilize the Create Transaction API to submit a new transaction to the Tutelar Server. Ensure that all relevant transaction details are included in your request. The Tutelar Server will validate the submitted transaction data.

Receive Transaction Validation Response: After validation, you will receive a response from the Tutelar Server containing the following critical pieces of information:

Risk Score: A numerical value indicating the risk level of the transaction.
Risk Status: A status indicator (e.g., high, medium, low) that reflects the assessed risk.
Reference Number: A unique identifier for the transaction, useful for tracking and reference purposes.
Customer Information: Details about the customer involved in the transaction.

Decision Making Based on Risk Assessment: Use the risk score, risk status, reference number, and customer information to decide whether to allow or deny the customer's payment. This decision is vital for fraud prevention and ensuring the security of transactions.

Update Transaction Status: Upon successful or failed payment, it is imperative to call the Transaction Status API to update the status of the previously completed transaction. This step ensures that the transaction records are accurate and up-to-date.

By following these steps, you can effectively manage and assess transaction risks, making informed decisions to approve or deny payments, thereby maintaining a secure and reliable payment process

Create a transaction

POSThttps://secctrl.tutelar.io/api/v1/fraud-detector/transaction/create

Body

deviceFingerPrintstring

Encoded device fingerprint information

Example: "ewogICJpcEFkZHJlc3MiOiAiNDkuMjQ5LjYyLjE5OCIsCiAgImJyb3dz"

orderId*string

Unique order ID to identify the transaction

Example: "ORD_10726"

customer*object

Contains detailed information about the customer involved in the transaction, including their name, email address, phone number, and the country code associated with their phone number.

amount*number (float)

The total amount of the transaction

Example: 299.99

currencyCode*string

The currency code in which the transaction is conducted (e.g.,INR, USD, EUR).

Example: "INR"

merchant*object

Contains detailed information about the merchant processing the transaction, including a unique identifier, name, email address, website URL, business name, and phone number

riskCodestring

A code representing the risk level of the transaction

Example: "CL00001"

productTypestring

The type of product being purchased

Example: "Ecommerce"

productDescriptionstring

A description of the product being purchased

Example: "Table"

billingobject

The billing details for the transaction

shippingobject

The shipping details for the transaction

paymentInstrument*string

The type of payment instrument used (e.g., credit card, debit card)

Example: "card"

paymentData*object

Contains specific details related to the payment method used for the transaction, including the name on the payment instrument, a secure token hash for the payment data, and the Bank Identification Number (BIN) of the payment instrument.

mccobject

The Merchant Category Code, which classifies the type of business.

industryobject

The industry in which the merchant operates.

udf1object

UDF (User Defined Fields) allow for custom data storage: udf1-udf8 are customizable fields. name: Label of the field. value: Content of the field, tailored to user needs.

udf2object

udf3object

udf4object

udf5object

udf6object

udf7object

udf8object

udf9object

udf10object

Response

Duplicate order id received

Body

successboolean

Example: false

messagestring

Example: "Duplicate order id received"

codeinteger

Example: 106

Request

const response = await fetch('https://secctrl.tutelar.io/api/v1/fraud-detector/transaction/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orderId": "ORD_10726",
      "customer": {
        "name": "",
        "email": "",
        "phone": ""
      },
      "amount": 299.99,
      "merchant": {
        "id": "TUTxxxxx19",
        "business_name": "Merchant Business Name"
      },
      "paymentInstrument": "card",
      "currencyCode": "INR",
      "paymentData": {
        "tokenHash": "aa0a953b06984294acda7d933a572df4"
      }
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "message": "Transaction risk results are",
  "data": {
    "orderId": "ORD_10726",
    "referenceNo": "TXNREFxxxxxxxNqQ",
    "requestedDateTime": "2023-09-11T13:01:28.937Z",
    "responseDateTime": "2023-09-11T13:01:29.234Z",
    "processedTime": 297,
    "merchant_details": {
      "id": "TUTxxxxx19",
      "name": "Merchant",
      "email": "merchant@gmail.com",
      "business_name": "Merchant Business Name",
      "website_url": "http://merchantbusiness.com",
      "phone": "9876xxxx10",
      "reseller": {
        "id": "ABCD",
        "reseller_id": "TUTxxxxxxx01",
        "name": "Reseller",
        "business_name": "Reseller Business Name",
        "email": "reseller@gmail.com"
      }
    },
    "customer": {
      "name": "Customer",
      "email": "customer@gmail.com",
      "phone": "9876xxxx10",
      "product_description": "Table",
      "product_type": "Ecommerce"
    },
    "transaction_details": {
      "amount": 1777,
      "status": "initiated"
    },
    "risk_details": {
      "status": "attempt",
      "score": 70,
      "type": "high",
      "engine_code": "CLRISK00003",
      "engine_name": "Lesser than 1000 Transaction Amount - Risk Engine"
    },
    "rules_triggered": [
      {
        "group_id": "grp_uhUKg9l1K",
        "group_code": "GRP0001",
        "score": 70,
        "description": "Test",
        "group_rules": [
          {
            "rule_code": "RULE00169",
            "rule_inputs": "General - Transaction Amount - Greater than - with the value - 1000"
          }
        ]
      }
    ],
    "payment_instrument": {
      "payment_instrument_type": "card",
      "card_holder_name": "Customer",
      "card_using_bank": "JPMORGAN CHASE BANK N.A",
      "card_type": "CREDIT",
      "card_country": "INDIA",
      "card_bin_number": "400000",
      "card_brand": "VISA",
      "card_sub_brand": "CLASSIC",
      "card_country_code": "IN",
      "dr_presence": false
    },
    "ip_address": {
      "address": "49.249.62.198",
      "country": "India",
      "region": "N/A",
      "city": "N/A",
      "country_code": "IN",
      "latitude": 21.9974,
      "longitude": 79.0011,
      "dr_presence": false
    },
    "phone_number": {
      "number": "9876xxxx10",
      "country": "",
      "city": "",
      "region": "",
      "dr_presence": false
    },
    "email_address": {
      "address": "customer@gmail.com",
      "free": "",
      "disposable": "",
      "domain": "",
      "dr_presence": false
    },
    "device_details": {
      "id": "187f563212bc63635ca2ae",
      "device_type": "web",
      "device_accuracy": "",
      "device_profile_score": "",
      "operating_system": "Mac OS",
      "source_ip": "49.249.62.198",
      "source_ip_country": "India",
      "flash_data": false,
      "packet_vpn": "",
      "packet_tor": "",
      "session_id": "",
      "pdf_viewer_enabled": true,
      "battery_info": "66%",
      "timestamp": 1689134135400,
      "timezone": "",
      "browser_name": "Chrome",
      "browser_version": "114",
      "private_window": false,
      "browser_hash": "cfea2c3e90ee0d2ab5699472c591a2be",
      "browser_vendor": "Google Inc.",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML like Gecko) Chrome/114.0.0.0 Safari/537.36",
      "cookie_enabled": true,
      "cookie_wiped_out": false,
      "cookie_hash": "1623e82f9758b02e9abd7b91c4da2066",
      "flash_enabled": false,
      "java_enabled": false,
      "ad_blocked": false,
      "color_depth": 30,
      "canvas_hash": "198a3f5dcbc1dcbc7a07005cc120255a",
      "supports_web_rtc": true,
      "region_language": "en-GB",
      "screen_type": "landscape-primary",
      "screen_height": 847,
      "screen_width": 1536,
      "font_count": 2,
      "font_list": [
        "Glyphicons Halflings"
      ],
      "font_hash": "c3967171939c1aad61b406744c478f56",
      "webgl_hash": "990a2eff746c4de710c1d7d38bc22130",
      "plugin_list": [
        "PDF Viewer"
      ],
      "plugin_count": 5,
      "webrtc_activated": true,
      "dr_presence": false
    }
  }
}

The Customer object is optional. If values are provided, they will be validated

Warning:

The maximum length of request parameters

orderId: 40 characters,
customer.name: 120 characters,
merchant.id: 20 characters,
merchant.name: 120 characters,
merchant.email: 40 characters,
merchant.business_name: 120 characters,
merchant.website_url: 200 characters,

Pre Auth and Post Auth

The Transaction Create API has been enhanced to support both pre-authorization (pre-auth) and post-authorization (post-auth) transaction flows. API Description

The Create API handles the creation of transactions in the pre-auth flow. For the post-auth flow, it also updates transaction details if transactionId and status are present in the request payload (postData).

API Endpoint: https://stgsecctrl.tutelar.io/api/v1/fraud-detector-onstream/transaction/create

Process Flow

Pre-Auth Flow:

The API performs the standard transaction creation logic.

Post-Auth Flow:

The API performs the standard transaction creation logic.
Additionally, if transactionId and status are present in the request payload:
1. It updates the transaction status, velocity, and risk results.
2. It calculates SLA durations and schedules jobs to update SLA transactions if required.

Post Data

The request payload should be a JSON object containing the necessary transaction details. For post-auth flows, it should include transactionId and status:

If the transaction is made in the post-auth flow, add the following data to the create API post data:

{
 "status": "success"   
 "transactionId": "trans_6789"
}

Use Cases

Valid Transaction ID and Status:

Scenario: Providing both a valid transactionId and status.
Expected Result: The API creates the transaction & updates the transaction details.

Invalid Status With Transaction ID:

Scenario: Providing an invalid status.
Expected Result: The API processes the request as a standard pre-auth transaction creation, ignoring the status and transactionId.

Status Without Transaction ID:

Scenario: Providing a status without a transactionId.
Expected Result: The API processes the request as a standard pre-auth transaction creation, ignoring the status.

Existing Transaction ID:

Scenario: Providing an existing transactionId.
Expected Result: The API creates the transaction & doesn’t update the transaction details.

PreviousIntroduction NextNotify Transaction

Last updated 1 month ago