Merchant Management
API's to create and manage merchants
Introduction
Merchants (mid) in TxShield are treated as the parent node of a Tree. The layer underneath the Merchant is the Retailer (rid) and the lowest node is a Site (sid).
Merchant --> Retailer --> Site
A Site is the object that actions / transactions are done on, in the system. If I wanted to process cred card transaction, i would create a payment Site, and use the credentials for that site to process payments. If I wanted to 3ds Authentications, I would create a 3ds Site and use those credentials to do 3ds Authentications with the 3ds SDK.
To create a Merchant, you will need to call the merchant create endpoint. This will return a Merchant id (mid). You can then use this mid to create a Retailer by call the retailer create endpoint. This will return a Retailer Id (rid). Using the rid you can then create a Site by calling the site create endpoint. This will return a Site Id (sid).
Authentication
Every call on this page requires a Bearer token to be sent in the Authorization header. You can obtain a Bearer token from the System Administrator.
Merchant, Retailer, Site.
Merchant Create
Create a new merchant in the system. This call will return a MID that can be used to create Retailers. list of available themes can be retrieved from the themes endpoint.
Example JSON data.
{
"name": "New Merchant",
"payments": true,
"threeDS": true,
"alerts": true,
"cbm": true,
"order_insights": true,
"oi_merchant_id": "",
"remarks": "My New Merchant",
"themeid": 0
}Merchant Details
Returns the details of a Merchant, doesn't have any body parameters.
Retailer Create
Creates a new Retailer, you will need the mid of the Merchant that you want to attach the retailer too. A list of available currencies can be found at the currency endpoint. Example JSON data
{
"name": "New Retailer",
"currency": "USD",
"margin_percentage": 0,
"contact_email": "[email protected]",
"remarks": "Created At xx",
"description": "For my USD Sites"
}Retailer Details
Returns the details of a Retailer
Site Create
Create a new Site, You will need the mid and rid of the merchant/retailer you want this site attached too. A list of available resellers can be found at the reseller endpoint. A list of available support groups can be found at the support group endpoint. A list of available categories can be found at the categories endpoint. Example JSON data:
{
"name": "string",
"reseller_id": 0,
"url": "string",
"remarks": "string",
"description": "string",
"currency": "string",
"support_group": 0,
"cat_id": 0
}Site Details
Returns the details of a site. Doesn't have any body params.
Site List
Returns a list of sites. Doesn't have any body params.
Site Payment
Marks a site as a Payment site. Once set to payment, the site can never be changed to 3ds or Alert. A list of available fraud templates can be retrieved from the fraud template endpoint. Example JSON data.
{
"stop_send_email": 0,
"cbreportemail": "string",
"ftid": 0,
"skip_ccv": 0,
"bin_currency": 0,
"allow_rebilling": 0,
"proceedeveniffail": 0,
"margin_percentage": "string",
"first_transaction_alert": 0,
"notify_email": "string",
"allow_refund": 0,
"allow_refund_time": 0,
"emaildomain": "string",
"shipping_n_tracking": 0
}Site 3ds
Mark a site as a 3ds site. Once set to 3ds, the site can never be changed to Payment or Alert. Example JSON data
{
"settings": {
"clientMode": "string",
"enableResult": "string",
"disableChallenge": "string",
"enable3ds1Frictionless": "string",
"enable3DS1Only": "string",
"requestorName": "string",
"requestorURL": "string",
"authenticationInd": "string",
"challengeInd": "string",
"acctType": "string",
"acquirerMerchantPwd": "string",
"mcc": "string",
"merchantCountryCode": "string",
"merchantName": "string",
"messageCategory": "string",
"purchaseCurrency": "string",
"transType": "string",
"verbose": 0,
"acquirerBin": "string",
"acquirerMid": "string",
"masterAcquirerBin": "string",
"masterAcquirerMid": "string",
"JCBAcquirerBin": "string",
"JCBAcquirerMid": "string",
"CUPAcquirerBin": "string",
"CUPAcquirerMid": "string",
"AMEXAcquirerBin": "string",
"AMEXAcquirerMid": "string"
},
"shieldsettings": {
"skip3d2": 0,
"three_ds_provider": "string",
"threedsprotocolversion": "string",
"paayauth3d2": "string",
"gpay_merchant_token": "string",
"gpay_merchant_id": "string",
"gpay_base_url": "string",
"hitrust_account_id": "string",
"hitrust_password": "string",
"hitrust_base_url": "string",
"hitrust_mastercard_prefix": "string"
}
}Site Alert
Set a site as an Alert site. Once set to Alert it can never be changed to Payment or 3ds. Example JSON data
{
"alertapiurl": "string",
"descriptorid": "string",
"username": "string",
"token": "string",
"default_dispute_action": "string",
"max_refund_amount": 0,
"alert_triggeremail": 0,
"alert_email": "string",
"shieldrdr_review_email": "string",
"statusupdate_url": "string"
}Supporting Data
County List
List of countries and their country codes.
Currency List
A list of supported currency and their currency codes.
Fraud Template List
A list of currently setup Fraud Templates.
Reseller List
A list of available resellers.
Support Group List
A list of support groups.
Theme List
A list of available themes.
Site Category List
A list of available site categories.
Payment Method List
A list of supported Payment Methods.
Last updated