TSYS Transit Parameter Push

This API is only for TSYS Transit Varsheet.

ENV

PROTOCOL

METHOD

API URL

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

Name

Value

Content-Type

application/json

jwt-token

Token Provided by Paywizard

sign

PayWizard Open Platform API Signature Guide V3

Request

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

NAME

VAR

MANDATORY

TYPE

EXAMPLE

DESC

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"
}

PreviousQuick Start - Payment Parameter Push NextFiserv Parameter Push

Last updated 9 hours ago