Create Transaction

By using Create Transaction API, the Client can submit a new transaction to Tutelar Server. Before initiating this process you should whitelist the server IP address at Tutelar Panel and API Keys should be generated. After validating the posted transaction, you will get the risk score, risk status, reference number, and customer information. This response will help you to allow or deny customers to complete payment against your order. Upon successful or failed payment, you should call Transaction Status API to update the status of a previously completed transaction. Kindly find the Transaction Status API for more reference.

Create Transaction

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

Post parameters description is given below,

Post Parameter	Type	Is Mandatory	Description
orderId	Alphanumeric	Yes	It should be unique. It helps to identify the new transaction that comes from which merchant.
customer	Object	Yes Except (countryCode)	To store customer Name, Email address , Phone number & Country code
amount	Numeric	Yes	To send transaction Amount of particular transaction
paymentInstrument	String	Yes	You can pass "card", "upi", "wallet", and "ft"
currencyCode	String	Yes	It helps to send Currency code of originated transaction country
merchant	Object	Optional Except (id and business_name)	It helps to submit transacting Merchant related information. To store Merchant ID, Email address, Name, Business name, Phone number & Website Url
productType	String	Optional	It helps to send product type information for an example "Ecommerce"
productDescription	String	Optional	It helps to send detailed product description
billing	Object	Optional	To send billing-related information such as an Name, Address, City, State, Country & Postal code,
shipping	Object	Optional	To send shipping-related information such as an Name, Email address, Phone number, Address, City, , Method, Period, State, Country & Postal code
paymentData	Object	Optional Except (tokenHash)	It helps to send payment-related information like Bin, Name & Token hash details. Note: If Payment Instrument is given ft , user need to given IFSC and Type.
deviceFingerPrint	Object	Optional	It helps to store requested device information like IP Address, Browser, Cookies, Device and Zones. If it is Android SDK, click here If it is Flutter SDK, click here If it is iOS SDK, click here If it is Web, click here
riskCode	String	Optional	If customer given the riskCode field, the given riskCode is first priority. So It will triggered First.
mcc	Object	Optional	If customer given the mcc field, the given mcc has risk engine is assign it will triggered.
industry	Object	Optional	If customer given the industry field, the given mcc has risk engine is assign it will triggered.

Post Parameter

Type

Is Mandatory

Description

orderId

Alphanumeric

Yes

It should be unique. It helps to identify the new transaction that comes from which merchant.

customer

Object

Yes Except

(countryCode)

To store customer Name, Email address , Phone number & Country code

amount

Numeric

Yes

To send transaction Amount of particular transaction

paymentInstrument

String

Yes

You can pass "card", "upi",

"wallet", and "ft"

currencyCode

String

Yes

It helps to send Currency code of originated transaction country

merchant

Object

Optional Except (id and business_name)

It helps to submit transacting Merchant related information. To store Merchant ID, Email address, Name, Business name, Phone number & Website Url

productType

String

Optional

It helps to send product type information for an example "Ecommerce"

productDescription

String

Optional

It helps to send detailed product description

billing

Object

Optional

To send billing-related information such as an Name, Address, City, State, Country & Postal code,

shipping

Object

Optional

To send shipping-related information such as an Name, Email address, Phone number, Address, City, , Method, Period, State, Country & Postal code

paymentData

Object

Optional

Except (tokenHash)

It helps to send payment-related information like Bin, Name & Token hash details. Note: If Payment Instrument is given ft , user need to given IFSC and Type.

deviceFingerPrint

Object

Optional

It helps to store requested device information like IP Address, Browser, Cookies, Device and Zones. If it is Android SDK, click here If it is Flutter SDK, click here

If it is iOS SDK, click here If it is Web, click here

riskCode

String

Optional

If customer given the riskCode field, the given riskCode is first priority. So It will triggered First.

mcc

Object

Optional

If customer given the mcc field, the given mcc has risk engine is assign it will triggered.

industry

Object

Optional

If customer given the industry field, the given mcc has risk engine is assign it will triggered.

Sample Post Parameters

 {
    "deviceFingerPrint":
"ewogICJpcEFkZHJlc3MiOiAiNDkuMjQ5LjYyLjE5OCIsCiAgImJyb3dzZXIiOiB7CiAgICAiYnJvd3
mZXJlbmNlX21pbnV0ZXMiOiAwLAogICAgICAiZGlmZmVyZW5jZV9zZWNvbmRzIjogMAogICAgfQogIH0
KfQ==",
    "orderId": "ORD_10726",
    "customer": {
        "name": "Customer",
        "email": "customer@gmail.com",
        "phone": "9876xxxx10",
        "countryCode":"+91"
    },
    "amount": 299,
    "currencyCode": "INR",
    "merchant":{
        "id": "TUTxxxxx19",
        "name": "Merchant",
        "email": "merchant@gmail.com",
        "business_name": "Merchant Business Name",
        "website_url": "http://merchantbusiness.com",
        "phone": "9876xxxx10",
    },
    "riskCode": "CL00001",
    "productType": "Ecommerce",
    "productDescription": "Table",
    "billing": {
        "address": "B16 and B17, 2nd floor, SIDCO Industrial Estate, Guindy"
        "city": "Chennai",
        "name": "Ippopay",
        "postalCode": "600032",
        "state": "Tamilnadu",
        "country": "India"
    },
    "shipping": {
        "address": "B16 and B17, 2nd floor, SIDCO Industrial Estate, Guindy"
        "city": "Chennai",
        "country": "India",
        "email": "support@ippopay.com",
        "method": "1",
        "name": "Ippopay",
        "period": "1",
        "phone": "9876xxxx10",
        "postalCode": "600032",
        "state": "Tamilnadu"
    },
    "paymentInstrument": "card",
    "paymentData": {
        "bin": "400000xxxxxxxx00",
        "name": "Ippopay",
        "tokenHash": "aa0a953b06984294acda7d933a572df4",
        "ifsc": "IFSC0009591",
        "type": "imps"
    },
    "mcc": {
        "id": "2zYroPJ1074",
        "code": "9311",
        "description": "Tax Payments"
    },
    "industry": {
         "id": "qiGunPvJ1",
         "name": "Financial Services",
         "code": "IND00024"
     },
    "udf1": {
        "value": "",
        "name": ""
    },
    "udf2": {
        "value": "",
        "name": ""
    },
    "udf3": {
        "value": "",
        "name": ""
    },
    "udf4": {
        "value": "",
        "name": ""
    },
    "udf5": {
        "value": "",
        "name": ""
    },
    "udf6": {
        "value": "",
        "name": ""
    },
    "udf7": {
        "value": "",
        "name": ""
    },
    "udf8": {
        "value": "",
        "name": ""
    },
    "udf9": {
        "value": "",
        "name": ""
    },
    "udf10": {
        "value": "",
        "name": ""
    }
}

Post Transaction Response

If Transaction is Success

{
    "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",
                "FontAwesome"
            ],
            "font_hash": "c3967171939c1aad61b406744c478f56",
            "webgl_hash": "990a2eff746c4de710c1d7d38bc22130",
            "plugin_list": [
                "PDF Viewer",
                "Chrome PDF Viewer",
                "Chromium PDF Viewer",
                "Microsoft Edge PDF Viewer",
                "WebKit built-in PDF"
            ],
            "plugin_count": 5,
            "webrtc_activated": true,
            "dr_presence": false
        }
    }
}

If Invalid Credentials

{
    "message": "Invalid authentication credentials"
}

If a transaction already exists #

  { 
    "success": false,
    "message": "Duplicate order id received",
    "code": 106,
    "data": {
        "orderId": "ORD_10726",
        "referenceNo": "TXNREFxxxxxxxNqQ",
        "requestedDateTime": "2022-12-28T12:17:14.154Z",
        "responseDateTime": "2022-12-28T12:17:14.1830Z",
        "processedTime": 29,
        "device": {
            "deviceType": "desktop",
            "ipAddress": "49.249.62.198",
            "userAgent": "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"
        },
        "customer": {
            "name": "Customer",
            "email": "customer@gmail.com",
            "phone": "9876xxxx10"
        }
    }
}

If Product is Unsubscribed

{
    "success": false,
    "code": 500,
    "message": "You are not subscribe this product. Please contact admin."
}

If a Merchant not Approved

{ 
    "success": false,
    "code": 422,
    "message": "Merchant status is not approved"
}

If a Merchant Deactivated

{
    "success": false,
    "code": 422,
    "message": "Merchant status is deactivated"
}

PreviousIntroduction NextNotify Transaction

Last updated 20 days ago