Transaction Risk API
Handles the evaluation of risk associated with transaction attempts, allowing for the detection and prevention of suspicious transactions.
Transaction Risk API
The Transaction Risk API is designed to assist organizations in identifying and mitigating fraudulent transaction attempts. This endpoint assesses the risk associated with financial transactions, providing a risk score and severity level based on multiple factors. By integrating this API, organizations can prevent fraudulent or suspicious transactions that could compromise their financial security. The API enhances security measures by enabling immediate responses to high-risk transactions, thus safeguarding the integrity of financial operations and ensuring a secure transactional environment.
Request Structure
Endpoint: /v1/transaction
Hostname: https://a.sensfrx.ai
Method: POST
Headers:
Authorization
: Basic Auth encoded in Base64.Content-Type
: application/json
Request Body:
{
"ev": "attempt_succeeded",
"dID": "Device-JWT-USER-ID",
"tfs": {
"transaction_id": 123456789,
"transaction_type": "Purchase",
"email": "admin1@yopmail.com",
"first_name": "admin1",
"last_name": "admin",
"username": "admin",
"user_id": "1",
"payment_mode": "Digital Wallet",
"payment_provider": "Paypal",
"card_fullname": "A",
"card_bin": "A",
"card_expire": "A",
"card_last": "A",
"cvv": "A",
"phone_no": "89067676",
"transaction_amount": "148",
"transaction_currency": "INR",
"items": [
{
"item_id": "1",
"item_name": "Lotus",
"item_category": "Flower",
"item_quantity": "1",
"item_price": "49",
"item_url": "A"
},
{
"item_id": "1",
"item_name": "Lily",
"item_category": "Flower",
"item_quantity": "1",
"item_price": "49",
"item_url": "A"
}
],
"shipping_country": "India",
"shipping_state": "UP",
"shipping_city": "Bijnor",
"shipping_zip": "246734",
"shipping_phone": "8989595",
"shipping_fullname": "Ashish",
"shipping_method": "Standard",
"billing_country": "Inida",
"billing_state": "UP",
"billing_city": "Bijnor",
"billing_zip": "246727",
"billing_phone": "80578578",
"merchant_name": "Flower Valley",
"merchant_category": "Flowers",
"merchant_id": "123",
"merchant_country": "India"
},
"h": {
"ip": "45.252.1.123",
"ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36",
"ho": "demo.sensfrx.ai",
"rf": "https://demo.sensfrx.ai/register.php",
"ac": {
"a": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
"ae": "gzip, deflate, br",
"al": "en-US,en;q=0.9,hi;q=0.8,mr;q=0.7"
},
"url": "http://demo.sensfrx.ai/payment.php"
}
}
POST Parameters:
ev
(string): Event type ,This can have 4 values:When user clicks on pay now button : attempt_succeeded, attempt_failed
After the payment is processed : transaction_succeeded, transaction_failed
dID
(string): Unique identifier for the device.timestamp
(string): The time of the registration attempt in ISO 8601 format.rfs
(object): Registration form specifics.transaction_id
(integer): Unique identifier assigned to each transaction.transaction_type
(string) : Type of transaction. Possible values include:purchase
sale
withdraw
deposit
transfer
reward
affiliate_id
(string): User's unique affiliate identifier.affiliate_name
(string): User's affiliate name.email
(string): Email of the registered user.first_name
(string): User's first name.last_name
(string): User's last name.username
(string): Registered username.user_id
(string): Unique identifier for the user.payment_mode
(string): Mode of payment. Possible values include:card
digital_wallet
crypto_wallet
wire_transfer
bank_transfer
cod
others
payment_provider
(string): Payment provider. Possible values include:paypal
stripe
skrill
2checkout
adyen
helcim
braintree
boleto
blinc
apple_pay
google_pay
android_pay
amazon_pay
samsung_pay
others
card_fullname
(string): Full name on the card.card_bin
(string): First 4 or 6 digits of the card.card_expire
(string): Expiration date of the card. (Format: MM/YYYY)card_last
(string): Last 4 digits of the card.card_token
(string): Token issued by the card issuer.cvv
(string): CVV number.phone_no
(string): Phone number with country code.transaction_amount
(string): Amount of the transaction.transaction_currency
(string): Currency of the transaction.items
(object): Array of objects containing item details. Each item object should include the following keys:item_id: Identifier for the item.
item_name: Name of the item.
item_category: Category of the item.
item_quantity: Quantity of the item.
item_price: Price of the item.
item_url: URL of the item.
item_<custom>( format should be same for other custom values )
Eg. - [{“item_id”:1,”item_category”:”book”,”item_quantity” : 1,”item_price”,”588”}]
shipping_cost
(string): Cost of shipping.shipping_country
(string): Country in the shipping address.shipping_state
(string): State in the shipping address.shipping_city
(string): City in the shipping address.shipping_zip
(string): Zip code in the shipping address.shipping_phone
(string): Phone number with country code in the shipping address.shipping_fullname
(string): Full name in the shipping address.shipping_method
(string): Shipping method. Possible values include:Standard
UPS
USPS
DHL
Fedex
others
billing_country
(string): Country in the billing address.billing_state
(string): State in the billing address.billing_city
(string): City in the billing address.billing_zip
(string): Zip code in the billing address.billing_phone
(string): Phone number with country code in the billing address.merchant_name
(string): Full name of the merchant.merchant_category
(string): Category of the merchant.merchant_id
(string): Unique identifier for the merchant.merchant_country
(string): Country code of the merchant.
h
(object): Header information.ip
(string): IP address of the user.ua
(string): User agent string.ho
(string): Hostname of the registration page.url
(string): URL of the registration page.
Response
{
"status": "allow",
"severity": "low",
"risk_score": 11,
"shadow_mode": "0",
"device": {
"device_id": "dFQjCFRjDA5Q%2Fb8pL0CKFgiGWFJOhhtLNXknQHwVlEYwbxu%2B4ojymgjLJ91KBuRxA%2Bh83yCCjXqycQOPbtvLcc64kcgG8h3e%2BuaqRfWkD2U0NwgFfRbVFz4PA7mjQoyLybhTcGBETr5j4xED0pndUXFSNtRRviDc%2FmluS8y18Z4tnqXDcYuiz%2BxlAMSA",
"name": "Chrome on Windows 10",
"ip": "45.252.74.134",
"location": "Aurangabad, MH, IN"
},
"message": "Transaction Request successfully reached."
}