TSYS Transit Parameter Push
This API is only for TSYS Transit Varsheet.
UAT
HTTP
POST
https://uat.paywizard.biz/ovstrade/varsheet/tsystrasit/configuration/push
PROD
HTTP
POST
https://portal.paywizard.biz/ovstrade/varsheet/tsystrasit/configuration/push
Http Header
Content-Type:application/json
jwt-token:Developer Token
Request
clientId
Developer ID
String
pushData
Data Pack
Object
--terminalSn
Payment Terminal Serial Number
String
The terminal for push parameter
--terminalNumber
Terminal Number
String
--dbaName
Merchant DBA
String
--merchantAddress
Merchant Address
Object
----address1
Address
String
----city
Merchant City
String
----state
Merchant State
String
----zipcode
Merchant Zipcode
String
--legalPhone
Legal Phone
String
--dbaPhone
DBA Phone
String
--cardTypesAccepted
Card Type Accepted
Object
----americanExpress
American Express
String
----discoverPayPalDinersJCB
Discover\PayPal\Diners\JCB
String
--ebtFcsAndService
EBT FCS # AND Service
String
--vitalMerchantId
Vital Merchant ID
String
--location
Location
String
--application
Application
String
--closeMethod
Close Method
String
--authPrimaryPhone
Auth Primary Phone
String
--authSecondPhone
Auth Second Phone
String
--settlePrimaryPhone
Settle Primary Phone
String
--settleSecondPhone
Settle Second Phone
String
--sicCode
SIC Code
String
--agencyNumber
Agency Number
String
--storeNumber
Store Number
String
--acquirerId
Acquirer ID
String
--chainNumber
Chain Number
String
--countryCode
Country Code
String
--timeZoneInd
Time Zone Ind
String
--authTid
Auth TID
String
--settlementTid
Settlement TID
String
--termLifecycleCode
Term Lifecycle Code
String
--semiIntegratedDownloadId
Semi Integrated Download ID
Object
----downloadId
Download ID
String
----gatewayAddress
Gateway Address
String
----ipAddress
IP Address
String
----dns1
DNS1
String
----subnetMask
Subnet Mask
String
----dns2
DNS2
String
--paymentAppParams
paymentAppParams
Object
----adminPass
adminPass
String
----merchantPass
merchantPass
String
----superPass
superPass
String
----refundPass
refundPass
String
----reversalPass
reversalPass
String
----mid
mid
String
----deviceId
deviceId
String
----merchantCategoryCode
merchantCategoryCode
String
----countryCode
countryCode
String
----currencyCode
currencyCode
String
----unattended
unattended
String
----userId
userId
String
----userPassword
userPassword
String
----developerId
developerId
String
----facilitatorId
facilitatorId
String
----facilitatorName
facilitatorName
String
----acqInterRefNo
acqInterRefNo
String
----masterAccAddr
masterAccAddr
String
----accCustPhone
accCustPhone
String
----masterAccPhone
masterAccPhone
String
----subMerchantName
subMerchantName
String
----subMerchantId
subMerchantId
String
----subMerchantCountryCode
subMerchantCountryCode
String
----subMerchantStateCode
subMerchantStateCode
String
----subMerchantCity
subMerchantCity
String
----subMerchantPostalCode
subMerchantPostalCode
String
----subMerchantEmailId
subMerchantEmailId
String
----subMerchantPhone
subMerchantPhone
String
----merchantName
merchantName
String
----merchantAddress1
merchantAddress1
String
----merchantCity
merchantCity
String
----merchantState
merchantState
String
----cityCode
cityCode
String
----ebtFcsid
ebtFcsid
String
----merchantPhone
merchantPhone
String
----autoSettle
autoSettle
String
----businessCloseTime
businessCloseTime
String
----printReceipt
printReceipt
String
----checkPaper
checkPaper
String
----enableTip
enableTip
String
----tipDefault
tipDefault
String
----restrictMaxTipAmount
restrictMaxTipAmount
String
----maxTipAmount
maxTipAmount
String
----enableTax
enableTax
String
----taxDefault
taxDefault
String
----surchargeEnable
surchargeEnable
String
----enableCashDiscount
enableCashDiscount
String
----cashDiscountPercentage
cashDiscountPercentage
String
----addTipLineOnReceipt
addTipLineOnReceipt
String
----requireSignature
requireSignature
String
----hideAllMenu
hideAllMenu
String
----primIp
primIp
String
----tMKIndex
tMKIndex
String
----traceNo
traceNo
String
----batchNumber
batchNumber
String
----transExpiredDays
transExpiredDays
String
----facilitatorEnable
facilitatorEnable
String
----isIsLevelTwo
isIsLevelTwo
String
----isEstimated
isEstimated
String
----isDefender
isDefender
String
----forceOnlinePin
forceOnlinePin
String
----qpsAmount
qpsAmount
String
----tacDenial
tacDenial
String
----tacOnline
tacOnline
String
----tacDefault
tacDefault
String
----contactlessLimit
contactlessLimit
String
----contactlessCVM
contactlessCVM
String
----contactlessFloor
contactlessFloor
String
----terminalFloor
terminalFloor
String
----riskManageData
riskManageData
String
----terminalCap
terminalCap
String
----cvmCapNoCvm
cvmCapNoCvm
String
----cvmCapOnCvm
cvmCapOnCvm
String
----kernelConfig
kernelConfig
String
----extLogData
extLogData
String
----containerList
containerList
String
----aidHighestPriority
aidHighestPriority
String
----quickChip
quickChip
String
----supportIds
supportIds
String
----supportMaestro
supportMaestro
String
----supportUploadReceipt
supportUploadReceipt
String
----maxTrans
maxTrans
String
----creditSale
creditSale
String
----debitSale
debitSale
String
----forceAuth
forceAuth
String
----creditReturn
creditReturn
String
----debitReturn
debitReturn
String
----reversalMenu
reversalMenu
String
----printMenu
printMenu
String
----moreFunctionMenu
moreFunctionMenu
String
----authOnly
authOnly
String
----authIncrement
authIncrement
String
----tipAdjust
tipAdjust
String
----capture
capture
String
----closeBatch
closeBatch
String
Request Sample:
{
"clientId": "client12345",
"pushData": {
"terminalSn": "V5377738",
"merchantId": "5436845560417213", // Required: Merchant ID
"terminalNumber": "0004", // Required: Terminal Number
"dbaName": "Peblla, Inc", // Merchant DBA Name
"merchantAddress": {
"address1": "11820 Parklawn Dr, #330",
"city": "ROCKVILLE",
"state": "MD",
"zipcode": "20852"
},
"legalPhone": "(301) 661-8646",
"dbaPhone": "(301) 661-8646",
"cardTypesAccepted": {
"americanExpress": "1052487246",
"discoverPayPalDinersJCB": "601115011396817"
},
"ebtFcsAndService": "N",
"vitalMerchantId": "556041721300",
"location": "000001",
"application": "MultiPass",
"closeMethod": "NONE",
"authPrimaryPhone": "8774880737",
"authSecondPhone": "8772664012",
"settlePrimaryPhone": "8662656609",
"settleSecondPhone": "8662656610",
"sicCode": "8999",
"agencyNumber": "100740",
"storeNumber": "0001",
"acquirerId": "427539",
"chainNumber": "000000",
"countryCode": "840", // Maps to countryCode in XML
"timeZoneInd": "705",
"authTid": "D0.4275395436845560417213000001000489998402085270501",
"settlementTid": "54368455604172130000010004",
"clientId": "", // Can be obtained from business rules or Paywizard system
"termLifecycleCode": "", // Can be obtained from business rules or Paywizard system
"semiIntegratedDownloadId": {
"downloadId": "",
"gatewayAddress": "https://gateway.transit-pass.com/servlets/", // Maps to prim_ip in XML
"ipAddress": "",
"dns1": "",
"subnetMask": "",
"dns2": ""
},
"paymentAppParams": { // Payment application parameters, corresponding to fields in TsysPayment_cfg_pro(1).xml
"adminPass": "99999999",
"merchantPass": "1234",
"superPass": "123456",
"refundPass": "5555",
"reversalPass": "5555",
"mid": "5436845560417213", // Mapped from Merchant ID
"deviceId": "V5377738", // Mapped from Terminal ID
"merchantCategoryCode": "8999", // Mapped from SIC Code
"countryCode": "840", // Mapped from Country Code
"currencyCode": "", // To be supplemented or set with a default value
"unattended": "0", // Default value
"userId": "",
"userPassword": "",
"developerId": "003546G001", // Default value
"facilitatorId": "",
"facilitatorName": "",
"acqInterRefNo": "",
"masterAccAddr": "",
"accCustPhone": "",
"masterAccPhone": "",
"subMerchantName": "",
"subMerchantId": "",
"subMerchantCountryCode": "",
"subMerchantStateCode": "",
"subMerchantCity": "",
"subMerchantPostalCode": "",
"subMerchantEmailId": "",
"subMerchantPhone": "",
"merchantName": "Peblla, Inc", // Mapped from DBA Name
"merchantAddress1": "11820 Parklawn Dr, #330", // Mapped from Address
"merchantCity": "ROCKVILLE", // Mapped from Merchant City
"merchantState": "MD", // Mapped from Merchant State
"cityCode": "", // To be supplemented or set with a default value
"ebtFcsid": "N", // Mapped from EBT FCS # AND Service
"merchantPhone": "(301) 661-8646", // Mapped from Legal Phone or DBA Phone
"auto_settle": "1", // Default value
"businessCloseTime": "NONE", // Mapped from Close Method
"printReceipt": "0", // Default value
"checkPaper": "0", // Default value
"enableTip": "0", // Default value
"tipDefault": "", // Default value
"restrictMaxTipAmount": "0", // Default value
"maxTipAmount": "", // Default value
"enableTax": "0", // Default value
"taxDefault": "", // Default value
"surchargeEnable": "0", // Default value
"enableCashDiscount": "0", // Default value
"cashDiscountPercentage": "", // Default value
"addTipLineOnReceipt": "0", // Default value
"requireSignature": "0", // Default value
"hideAllMenu": "0", // Default value
"prim_ip": "https://gateway.transit-pass.com/servlets/", // Mapped from Gateway Address
"tMKIndex": "1", // Default value
"traceNo": "1", // Default value
"batchNumber": "1", // Default value
"transExpiredDays": "30", // Default value
"facilitatorEnable": "0", // Default value
"isIsLevelTwo": "0", // Default value
"isEstimated": "0", // Default value
"isDefender": "0", // Default value
"forceOnlinePin": "0", // Default value
"qpsAmount": "0", // Default value
"tacDenial": "0010000000", // Default value
"tacOnline": "DE00FC9800", // Default value
"tacDefault": "DC50FC9800", // Default value
"contactlessLimit": "99999999", // Default value
"contactlessCVM": "10000", // Default value
"contactlessFloor": "0", // Default value
"terminalFloor": "0", // Default value
"riskManageData": "4C00800000000000", // Default value
"terminalCap": "A008C8", // Default value
"cvmCapNoCvm": "08", // Default value
"cvmCapOnCvm": "08", // Default value
"kernelConfig": "B0", // Default value
"extLogData": "FFFFFFFFFFFFFFFF", // Default value
"containerList": "000000010000010100000201", // Default value
"aidHighestPriority": "0", // Default value
"quickChip": "0", // Default value
"supportIds": "0", // Default value
"supportMaestro": "1", // Default value
"supportUploadReceipt": "0", // Default value
"maxTrans": "500", // Default value
"creditSale": "1", // Default value
"debitSale": "1", // Default value
"forceAuth": "1", // Default value
"creditReturn": "1", // Default value
"debitReturn": "1", // Default value
"reversalMenu": "1", // Default value
"printMenu": "1", // Default value
"moreFunctionMenu": "1", // Default value
"authOnly": "1", // Default value
"authIncrement": "1", // Default value
"tipAdjust": "1", // Default value
"capture": "1", // Default value
"closeBatch": "1" // Default value
}
}
}
Response
Return Code
code
Int
200
Return code 200
indicates a normal transaction; any code other than 200
indicates an abnormal transaction.
Return Msg
msg
String
success
Return Data
data
Object
Push ID
--pushId
String
Push Status
--status
Integer
0: Parameter push in progres 1: Parameter push successful 2: Parameter push failed
Data/Time(UTC)
timestamp
String
2024-07-23 17:57:00
Response Sample
{
"code": 200,
"msg": "success",
"data": {
"pushId": "768206988353077248",
"status": 0
},
"timestamp": "2024-08-12 14:45:54"
}
Last updated