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

POSThttps://uat.txshield.payshield.ai/api/v3/merchant/create

Authorization

bearerAuth

Body

application/json

namestring

paymentsboolean

threeDSboolean

alertsboolean

cbmboolean

order_insightsboolean

oi_merchant_idstring

remarksstring

themeidinteger

Response

200400401404500

Successfully create merchant

Body

application/json

statusstring

msgstring

midinteger

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/merchant/create', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404500

{
  "status": "text",
  "msg": "text"
}

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

POSThttps://uat.txshield.payshield.ai/api/v3/merchant/{mid}/details

Authorization

bearerAuth

Path parameters

mid*integer

Merchant Id for get merchant details

Response

200401500

Successfully returned merchant details

Body

application/json

namestring

oi_merchant_idstring

remarksstring

themeidinteger

statusstring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/merchant/{mid}/details', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

{
  "name": "text",
  "oi_merchant_id": "text",
  "remarks": "text",
  "status": "text"
}

Returns the details of a Merchant, doesn't have any body parameters.

Retailer Create

POSThttps://uat.txshield.payshield.ai/api/v3/retailer/mid/{mid}/create

Authorization

bearerAuth

Path parameters

mid*integer

Merchant Id that related to retailer and retailer site

Body

application/json

namestring

currencystring

margin_percentageinteger

contact_emailstring

remarksstring

descriptionstring

Response

200400401404500

Successfully create retailer

Body

application/json

statusstring

msgstring

ridinteger

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/retailer/mid/{mid}/create', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404500

{
  "status": "text",
  "msg": "text"
}

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": "[e-mail]",
  "remarks": "Created At xx",
  "description": "For my USD Sites"
}

Retailer Details

POSThttps://uat.txshield.payshield.ai/api/v3/retailer/{rid}/details

Authorization

bearerAuth

Path parameters

rid*integer

Retailer Id for get retailer details

Response

200401500

Successfully returned retailer details

Body

application/json

namestring

rcodestring

remarksstring

descriptionstring

margin_percentagestring

contact_emailstring

currencystring

statusstring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/retailer/{rid}/details', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

{
  "name": "text",
  "rcode": "text",
  "remarks": "text",
  "description": "text",
  "margin_percentage": "text",
  "contact_email": "text",
  "currency": "text",
  "status": "text"
}

Returns the details of a Retailer

Site Create

POSThttps://uat.txshield.payshield.ai/api/v3/site/mid/{mid}/rid/{rid}/create

Authorization

bearerAuth

Path parameters

mid*integer

Merchant Id that related to retailer and retailer site

rid*integer

Retailer Id that related to retailer site

Body

application/json

namestring

reseller_idinteger

urlstring

remarksstring

descriptionstring

currencystring

support_groupinteger

support_group(id) is required field and not allowed for 0, for more information about support_group please see the endpoint /api/v3/datasource/supportgroup

cat_idinteger

cat_id is required field and not allowed for 0, for more information about cat_id please see the endpoint /api/v3/datasource/sitecategory

Response

200400401404500

Successfully create site

Body

application/json

statusstring

msgstring

sidinteger

rcodestring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/site/mid/{mid}/rid/{rid}/create', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404500

{
  "status": "text",
  "msg": "text",
  "rcode": "text"
}

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

POSThttps://uat.txshield.payshield.ai/api/v3/site/{sid}/details

Authorization

bearerAuth

Path parameters

sid*integer

Retailer Site Id for get site details

Response

200401500

Successfully returned site details

Body

application/json

namestring

categorystring

emaildomainstring

paymentsobject

threeDSobject

alertobject

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/site/{sid}/details', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

{
  "name": "text",
  "category": "text",
  "emaildomain": "text",
  "payments": {
    "details": {
      "name": "text",
      "description": "text",
      "remarks": "text",
      "url": "text",
      "support_site": "text",
      "support_email": "text",
      "support_phone": "text",
      "status": "text",
      "currency": "text",
      "creation_date": "text",
      "notify_email": "text",
      "cbreportemail": "text",
      "fx_provider_link": "text",
      "fx_provider_auth": "text",
      "smtpsetting": "text",
      "auth_expiry_days": "text",
      "shipperid": "text",
      "emaildomain": "text",
      "cart_margin_percentage": 0
    },
    "balance": 0,
    "accessRecords": [
      {
        "tx_actions": "text",
        "name": "text",
        "descriptor": "text",
        "currency_code": "text",
        "pay_method": "text",
        "max_limit_tx": "text",
        "max_limit_30days": "text"
      }
    ]
  },
  "threeDS": {
    "details": {
      "name": "text",
      "description": "text",
      "remarks": "text",
      "url": "text",
      "support_site": "text",
      "support_email": "text",
      "support_phone": "text",
      "status": "text",
      "currency": "text",
      "creation_date": "text",
      "notify_email": "text",
      "cbreportemail": "text",
      "fx_provider_link": "text",
      "fx_provider_auth": "text",
      "smtpsetting": "text",
      "auth_expiry_days": "text",
      "shipperid": "text",
      "emaildomain": "text",
      "cart_margin_percentage": 0
    },
    "settings": {
      "clientMode": "text",
      "enableResult": "text",
      "disableChallenge": "text",
      "enable3ds1Frictionless": "text",
      "enable3DS1Only": "text",
      "requestorName": "text",
      "requestorURL": "text",
      "authenticationInd": "text",
      "challengeInd": "text",
      "acctType": "text",
      "acquirerBin": "text",
      "acquirerMid": "text",
      "acquirerMerchantPwd": "text",
      "mcc": "text",
      "merchantCountryCode": "text",
      "merchantName": "text",
      "messageCategory": "text",
      "purchaseCurrency": "text",
      "transType": "text",
      "masterAcquirerBin": "text",
      "masterAcquirerMid": "text",
      "JCBAcquirerBin": "text",
      "JCBAcquirerMid": "text",
      "CUPAcquirerBin": "text",
      "CUPAcquirerMid": "text",
      "AMEXAcquirerBin": "text",
      "AMEXAcquirerMid": "text"
    },
    "shieldSettings": {
      "three_ds_provider": "text",
      "threedsprotocolversion": "text",
      "paayauth3d2": "text",
      "gpay_merchant_token": "text",
      "gpay_merchant_id": "text",
      "gpay_base_url": "text",
      "hitrust_account_id": "text",
      "hitrust_password": "text",
      "hitrust_base_url": "text",
      "hitrust_mastercard_prefix": "text"
    }
  },
  "alert": {
    "details": {
      "name": "text",
      "description": "text",
      "remarks": "text",
      "url": "text",
      "support_site": "text",
      "support_email": "text",
      "support_phone": "text",
      "status": "text",
      "currency": "text",
      "creation_date": "text",
      "notify_email": "text",
      "cbreportemail": "text",
      "fx_provider_link": "text",
      "fx_provider_auth": "text",
      "smtpsetting": "text",
      "auth_expiry_days": "text",
      "shipperid": "text",
      "emaildomain": "text",
      "cart_margin_percentage": 0
    },
    "settings": {
      "alertapiurl": "text",
      "descriptorid": "text",
      "username": "text",
      "password": "text",
      "default_dispute_action": "text",
      "alert_email": "text",
      "shieldrdr_review_email": "text",
      "statusupdate_url": "text"
    },
    "accessRecords": [
      {
        "tx_actions": "text",
        "name": "text",
        "descriptor": "text",
        "currency_code": "text",
        "pay_method": "text",
        "max_limit_tx": "text",
        "max_limit_30days": "text"
      }
    ]
  }
}

Returns the details of a site. Doesn't have any body params.

Site List

POSThttps://uat.txshield.payshield.ai/api/v3/site/list

Authorization

bearerAuth

Response

200401500

Successfully returned site list

Body

application/json

listarray of RetailerSiteListItem (object)

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/site/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

{
  "list": [
    {
      "name": "text"
    }
  ]
}

Returns a list of sites. Doesn't have any body params.

Site Payment

POSThttps://uat.txshield.payshield.ai/api/v3/site/mid/{mid}/rid/{rid}/sid/{sid}/payment

Authorization

bearerAuth

Path parameters

mid*integer

Merchant Id that related to retailer and retailer site

rid*integer

Retailer Id that related to retailer site

sid*integer

Retailer Site Id that related retailer site proceed to setup payment info

Body

application/json

stop_send_emailinteger

allowed for 0 or 1 only

ftidinteger

for more information about Fraud Template (ftid) please see the endpoint /api/v3/datasource/fraudtemplate

skip_ccvinteger

allowed for 0 or 1 only

bin_currencyinteger

allowed for 0 or 1 only

allow_rebillinginteger

allowed for 0 or 1 only

proceedeveniffailinteger

allowed for 0 or 1 only

margin_percentagestring

first_transaction_alertinteger

allowed for 0 or 1 only

notify_emailstring

allow_refundinteger

one of the value from [0,10,25,50,100,200,500,-1] per day; 0 = Never, -1 = Unlimited

allow_refund_timeinteger

one of the value from [0,1,2,3,4,5,6,7,8,9,10,15,20] Day(s); 0 = Not Active

emaildomainstring

shipping_n_trackinginteger

allowed for 0 or 1 only

Response

200400404500

Successfully setup payment site

Body

application/json

msgstring

detailsstring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/site/mid/{mid}/rid/{rid}/sid/{sid}/payment', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500

{
  "msg": "text",
  "details": "text"
}

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

POSThttps://uat.txshield.payshield.ai/api/v3/site/mid/{mid}/rid/{rid}/sid/{sid}/3ds

Authorization

bearerAuth

Path parameters

mid*integer

Merchant Id that related to retailer and retailer site

rid*integer

Retailer Id that related to retailer site

sid*integer

Retailer Site Id that related retailer site proceed to setup payment info

Body

application/json

settingsobject

shieldsettingsobject

Response

200400404500

Successfully setup payment site

Body

application/json

msgstring

detailsstring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/site/mid/{mid}/rid/{rid}/sid/{sid}/3ds', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500

{
  "msg": "text",
  "details": "text"
}

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

POSThttps://uat.txshield.payshield.ai/api/v3/site/mid/{mid}/rid/{rid}/sid/{sid}/alert

Authorization

bearerAuth

Path parameters

mid*integer

Merchant Id that related to retailer and retailer site

rid*integer

Retailer Id that related to retailer site

sid*integer

Retailer Site Id that related retailer site proceed to setup alert info

Body

application/json

alertapiurlstring

descriptoridstring

usernamestring

tokenstring

default_dispute_actionstring

one of the value from [match,match_n_refund]

max_refund_amountinteger

alert_triggeremailinteger

allowed for 0 or 1 only

alert_emailstring

shieldrdr_review_emailstring

statusupdate_urlstring

Response

200400404500

Successfully setup alert site

Body

application/json

msgstring

detailsstring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/site/mid/{mid}/rid/{rid}/sid/{sid}/alert', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500

{
  "msg": "text",
  "details": "text"
}

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

POSThttps://uat.txshield.payshield.ai/api/v3/datasource/country

Authorization

bearerAuth

Response

200401500

Successfully returned country list

Body

application/json

abrv_twostring

namestring

name_soundexstring

abrv_numericstring

abrv_currencystring

symbolstring

abrv_threestring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/datasource/country', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

[
  {
    "abrv_two": "text",
    "name": "text",
    "name_soundex": "text",
    "abrv_numeric": "text",
    "abrv_currency": "text",
    "symbol": "text",
    "abrv_three": "text"
  }
]

List of countries and their country codes.

Currency List

POSThttps://uat.txshield.payshield.ai/api/v3/datasource/defaultcurrency

Authorization

bearerAuth

Response

200401500

Successfully returned default currency list

Body

application/json

AUDany

Example: "Australian Dollar"

BTCany

Example: "Bitcoin"

BRLany

Example: "Brazil real"

GBPany

Example: "British Pound"

BGNany

Example: "Bulgarian lev"

CADany

Example: "Canadian Dollar"

COPany

Example: "Columbian Peso"

CZKany

Example: "Czech koruna"

DKKany

Example: "Danish krone"

EEKany

Example: "Estonian kroon"

EURany

Example: "Euro"

GHSany

Example: "Ghana Cedi"

GLDany

Example: "Gold"

HKDany

Example: "Hong Kong Dollar"

HUFany

Example: "Hungarian forint"

ISKany

Example: "Iceland krona"

INRany

Example: "Indian Rupee"

IDRany

Example: "Indonesian Rupee"

JPYany

Example: "Japanese Yen"

LVLany

Example: "Latvian lats"

LTLany

Example: "Lithuanian Litas"

MYRany

Example: "Malaysian ringgit"

MXNany

Example: "Mexican peso"

NZDany

Example: "New Zealand Dollar"

NGNany

Example: "Nigerian Naira"

NOKany

Example: "Norwegian krone"

PENany

Example: "Nuevo Sol (Peru)"

OMRany

Example: "Omani rial"

ARSany

Example: "Peso (Argentina)"

CLPany

Example: "Peso (Chile)"

UYUany

Example: "Peso (Uruguay)"

PHPany

Example: "Philippine peso"

PLNany

Example: "Polish zloty"

RONany

Example: "Romanian lei"

RUBany

Example: "Russian Ruble"

SGDany

Example: "Singapore Dollar"

ZARany

Example: "South African rand"

KRWany

Example: "South Korean Won"

SEKany

Example: "Swedish krona"

CHFany

Example: "Swiss franc"

TWDany

Example: "Taiwan Dollar"

THBany

Example: "Thai Baht"

TRYany

Example: "Turkish Lira"

USDany

Example: "US Dollar"

VNDany

Example: "Vietnam Dong"

WSTany

Example: "Western Samoan Tala"

CNYany

Example: "Yuan Renminbi"

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/datasource/defaultcurrency', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

{
  "AUD": "Australian Dollar",
  "BTC": "Bitcoin",
  "BRL": "Brazil real",
  "GBP": "British Pound",
  "BGN": "Bulgarian lev",
  "CAD": "Canadian Dollar",
  "COP": "Columbian Peso",
  "CZK": "Czech koruna",
  "DKK": "Danish krone",
  "EEK": "Estonian kroon",
  "EUR": "Euro",
  "GHS": "Ghana Cedi",
  "GLD": "Gold",
  "HKD": "Hong Kong Dollar",
  "HUF": "Hungarian forint",
  "ISK": "Iceland krona",
  "INR": "Indian Rupee",
  "IDR": "Indonesian Rupee",
  "JPY": "Japanese Yen",
  "LVL": "Latvian lats",
  "LTL": "Lithuanian Litas",
  "MYR": "Malaysian ringgit",
  "MXN": "Mexican peso",
  "NZD": "New Zealand Dollar",
  "NGN": "Nigerian Naira",
  "NOK": "Norwegian krone",
  "PEN": "Nuevo Sol (Peru)",
  "OMR": "Omani rial",
  "ARS": "Peso (Argentina)",
  "CLP": "Peso (Chile)",
  "UYU": "Peso (Uruguay)",
  "PHP": "Philippine peso",
  "PLN": "Polish zloty",
  "RON": "Romanian lei",
  "RUB": "Russian Ruble",
  "SGD": "Singapore Dollar",
  "ZAR": "South African rand",
  "KRW": "South Korean Won",
  "SEK": "Swedish krona",
  "CHF": "Swiss franc",
  "TWD": "Taiwan Dollar",
  "THB": "Thai Baht",
  "TRY": "Turkish Lira",
  "USD": "US Dollar",
  "VND": "Vietnam Dong",
  "WST": "Western Samoan Tala",
  "CNY": "Yuan Renminbi"
}

A list of supported currency and their currency codes.

Fraud Template List

POSThttps://uat.txshield.payshield.ai/api/v3/datasource/fraudtemplate

Authorization

bearerAuth

Response

200401500

Successfully returned fraud template list

Body

application/json

ftidinteger

namestring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/datasource/fraudtemplate', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

[
  {
    "name": "text"
  }
]

A list of currently setup Fraud Templates.

Reseller List

POSThttps://uat.txshield.payshield.ai/api/v3/datasource/reseller

Authorization

bearerAuth

Body

application/x-www-form-urlencoded

ridinteger

Retailer id from txshield core

Response

200401500

Successfully returned reseller list

Body

application/json

reseller_idinteger

namestring

currencystring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/datasource/reseller', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401500

[
  {
    "name": "text",
    "currency": "text"
  }
]

A list of available resellers.

Support Group List

POSThttps://uat.txshield.payshield.ai/api/v3/datasource/supportgroup

Authorization

bearerAuth

Response

200401500

Successfully returned support group list

Body

application/json

sgidstring

namestring

emailstring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/datasource/supportgroup', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

[
  {
    "sgid": "text",
    "name": "text",
    "email": "text"
  }
]

A list of support groups.

Theme List

POSThttps://uat.txshield.payshield.ai/api/v3/datasource/theme

Authorization

bearerAuth

Response

200401500

Successfully returned theme list

Body

application/json

themeidstring

theme_namestring

dashboard_urlstring

from_email_addressstring

from_namestring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/datasource/theme', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

[
  {
    "themeid": "text",
    "theme_name": "text",
    "dashboard_url": "text",
    "from_email_address": "text",
    "from_name": "text"
  }
]

A list of available themes.

Site Category List

POSThttps://uat.txshield.payshield.ai/api/v3/datasource/sitecategory

Authorization

bearerAuth

Response

200401500

Successfully returned site category list

Body

application/json

cat_idstring

categorystring

parentinteger

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/datasource/sitecategory', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

[
  {
    "cat_id": "text",
    "category": "text"
  }
]

A list of available site categories.

Payment Method List

POSThttps://uat.txshield.payshield.ai/api/v3/datasource/paymentmethods

Authorization

bearerAuth

Response

200401500

Successfully returned site category list

Body

application/json

pmidstring

pay_methodstring

typestring

regexstring

displaystring

pending_remindersstring

Request

JavaScriptCurlPython

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/datasource/paymentmethods', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

[
  {
    "pmid": "text",
    "pay_method": "text",
    "type": "text",
    "regex": "text",
    "display": "text",
    "pending_reminders": "text"
  }
]

A list of supported Payment Methods.