TSYS Transit Parameter Push

This API is only for TSYS Transit Varsheet.

Overview

This endpoint is used to upload and push TSYS Trasit payment configuration parameters to a specific terminal.

Environments

Environment	Protocol	HTTP Method	URL
Sandbox	HTTPS	POST	https://uat.paywizard.biz/ovstrade/openVarSheet/tsystrasit/configuration/push
Production	HTTPS	POST	https://portal.paywizard.biz/ovstrade/openVarSheet/tsystrasit/configuration/push

Authentication

Authentication is handled through a JSON Web Token (JWT) included in the request header. A signature must also be provided in the headers for request verification.

For detailed instructions on generating the required signature, please refer to our Signature Generation Guide.

---

Endpoint: Push TSYS Trasit Configuration

POST /ovstrade/openVarSheet/tsystrasit/configuration/push

Headers

Key	Type	Required	Description
Content-Type	String	Yes	Must be application/json.
jwt-token	String	Yes	The transaction token obtained using your developer credentials.
sign	String	Yes	The request signature. See Signature Generation Guide.

Request Body Parameters

Root Parameters

Name	Type	Description
clientId	string	Unique Developer ID.
pushData	object	The data object to be pushed.
pushData.terminalSn	string	Terminal Serial Number (SN).
pushData.paymentAppParams	object	Payment application specific parameters (see details below).

Detailed Configuration Parameters (paymentAppParams​ Structure)

For clarity, parameters are categorized by function:

1. Password Information (tsysPasswordInformation​)

Name	Type	Description
​adminPass​	string	Administrator Password
​merchantPass​	string	Merchant Password
​superPass​	string	Super Password
​refundPass​	string	Refund Password
​reversalPass​	string	Reversal Password

2. Merchant Parameters (tsysMerchantParam​)

Name	Type	Description
​userId​	string	User ID
​userPassword​	string	User Password
​merchantID​	string	Merchant ID (MID)
​deviceId​	string	Device ID (TID)
​legalName​	string	Legal Name
​dbaName​	string	DBA Name (Doing Business As)
​legalAddr​	string	Legal Address
​dbaAddr​	string	DBA Address
​merchantCity​	string	City
​merchantState​	string	State
​merchantPostal​	string	Postal/Zip Code
​merchantCountryCode​	string	Merchant Country Code (e.g., USA)
​countryCode​	string	Country Code (Numeric, e.g., 840)
​currencyCode​	string	Currency Code (Numeric, e.g., 840)
​merchantPhone​	string	Merchant Phone Number
​merchantEmail​	string	Merchant Email
​merchantCategoryCode​	string	MCC (Merchant Category Code)
​developerId​	string	Developer ID
​unattended​	string	Unattended Terminal Flag
​facilitatorId​	string	Facilitator ID
​acqInterRefNo​	string	Acquirer Internal Reference Number
​bannerUrls​	string	Banner Image URLs
​ebtFcsid​	string	EBT FCSID

3. Merchant Settings (tsysMerchantSetting​)

Name	Type	Description
​autoSettle​	string	Auto Settle (1: Enable, 0: Disable)
​businessCloseTime​	string	Business Close Time (for settlement)
​printReceipt​	string	Print Receipt
​checkPaper​	string	Check for Paper
​enableTip​	string	Enable Tipping
​tipDefault​	string	Default Tip Amount
​restrictMaxTipAmount​	string	Restrict Maximum Tip Amount
​maxTipAmount​	string	Maximum Tip Amount
​enableTax​	string	Enable Tax
​taxDefault​	string	Default Tax Rate
​surchargeEnable​	string	Enable Surcharge
​enableCashDiscount​	string	Enable Cash Discount
​cashDiscountPercentage​	string	Cash Discount Percentage
​addTipLineOnReceipt​	string	Add Tip Line on Receipt
​requireSignature​	string	Require Signature
​hideAllMenu​	string	Hide All Menus

4. Network Parameters (tsysNetworkParam​)

Name	Type	Description
​primIp​	string	Primary IP/Gateway URL

5. Terminal Parameters (tsysTerminalParam​)

Name	Type	Description
​tmkIndex​	string	TMK Key Index
​traceNo​	string	Trace Number
​batchNumber​	string	Batch Number
​enableAutoCloseBatch​	string	Enable Auto Close Batch
​autoCloseBatchTime​	string	Auto Close Batch Time
​transExpiredDays​	string	Transaction Expiration Days
​facilitatorEnable​	string	Enable Facilitator Mode
​isIsLevelTwo​	string	Is Level 2 Data Supported
​isEstimated​	string	Is Estimated
​isDefender​	string	Is Defender
​forceOnlinePin​	string	Force Online PIN
​qpsAmount​	string	QPS Amount Limit
​tacDenial​	string	TAC Denial Code
​tacOnline​	string	TAC Online Code
​tacDefault​	string	TAC Default Code
​contactlessLimit​	string	Contactless Limit
​contactlessCVM​	string	Contactless CVM Limit
​contactlessFloor​	string	Contactless Floor Limit
​terminalFloor​	string	Terminal Floor Limit
​riskManageData​	string	Risk Management Data
​terminalCap​	string	Terminal Capabilities
​cvmCapNoCvm​	string	CVM Capabilities (No CVM)
​cvmCapOnCvm​	string	CVM Capabilities (On CVM)
​kernelConfig​	string	Kernel Configuration
​extLogData​	string	Extended Log Data
​containerList​	string	Container List
​aidHighestPriority​	string	AID Highest Priority
​supportMsr​	string	Support MSR (Magnetic Stripe)
​quickChip​	string	Enable Quick Chip
​supportIds​	string	Support IDS
​supportMaestro​	string	Support Maestro
​supportUSMaestro​	string	Support US Maestro
​supportAmex​	string	Support Amex
​supportUploadReceipt​	string	Support Receipt Upload
​maxTrans​	string	Maximum Transactions per Batch

6. Supported Transaction Types (tsysSupportedTrans​)

Fields in this section are typically set to "1" (Supported) or "0" (Not Supported).

Name	Type	Description
​creditSale​	string	Credit Sale
​debitSale​	string	Debit Sale
​forceAuth​	string	Force Auth
​creditReturn​	string	Credit Return
​debitReturn​	string	Debit Return
​reversalMenu​	string	Reversal Menu
​printMenu​	string	Print Menu
​moreFunctionMenu​	string	More Functions Menu
​authOnly​	string	Auth Only
​authIncrement​	string	Auth Increment
​tipAdjust​	string	Tip Adjust
​capture​	string	Capture
​closeBatch​	string	Close Batch

---

Request Example

Note: The paymentAppParams object is extensive. This example shows the complete structure.

{
    "clientId": "825420368247390000",
    "pushData": {
        "terminalSn": "WP2310PQ20000000",
        "paymentAppParams": {
            "tsysPasswordInformation": {
                "adminPass": "99999999",
                "merchantPass": "1234",
                "superPass": "123456",
                "refundPass": "5555",
                "reversalPass": "5555"
            },
            "tsysMerchantParam": {
                "userId": "",
                "userPassword": "",
                "merchantID": "",
                "deviceId": "",
                "legalName": "",
                "dbaName": "",
                "legalAddr": "",
                "dbaAddr": "",
                "merchantCity": "",
                "merchantState": "",
                "merchantPostal": "",
                "merchantCountryCode": "USA",
                "countryCode": "840",
                "currencyCode": "840",
                "merchantPhone": "",
                "merchantEmail": "",
                "merchantCategoryCode": "",
                "developerId": "003546G004",
                "unattended": "0",
                "facilitatorId": "123",
                "acqInterRefNo": "",
                "bannerUrls": "",
                "ebtFcsid": ""
            },
            "tsysMerchantSetting": {
                "autoSettle": "1",
                "businessCloseTime": "",
                "printReceipt": "0",
                "checkPaper": "0",
                "enableTip": "0",
                "tipDefault": "",
                "restrictMaxTipAmount": "0",
                "maxTipAmount": "",
                "enableTax": "0",
                "taxDefault": "",
                "surchargeEnable": "0",
                "enableCashDiscount": "0",
                "cashDiscountPercentage": "",
                "addTipLineOnReceipt": "0",
                "requireSignature": "0",
                "hideAllMenu": "0"
            },
            "tsysNetworkParam": {
                "primIp": "https://gateway.transit-pass.com/servlets/"
            },
            "tsysTerminalParam": {
                "tmkIndex": "7",
                "traceNo": "1",
                "batchNumber": "1",
                "enableAutoCloseBatch": "0",
                "autoCloseBatchTime": "00:00",
                "transExpiredDays": "30",
                "facilitatorEnable": "0",
                "isIsLevelTwo": "0",
                "isEstimated": "0",
                "isDefender": "0",
                "forceOnlinePin": "0",
                "qpsAmount": "0",
                "tacDenial": "0010000000",
                "tacOnline": "DE00FC9800",
                "tacDefault": "DC50FC9800",
                "contactlessLimit": "99999999",
                "contactlessCVM": "10000",
                "contactlessFloor": "0",
                "terminalFloor": "0",
                "riskManageData": "4C00800000000000",
                "terminalCap": "A008C8",
                "cvmCapNoCvm": "08",
                "cvmCapOnCvm": "08",
                "kernelConfig": "B0",
                "extLogData": "FFFFFFFFFFFFFFFF",
                "containerList": "000000010000010100000201",
                "aidHighestPriority": "1",
                "supportMsr": "0",
                "quickChip": "1",
                "supportIds": "1",
                "supportMaestro": "1",
                "supportUSMaestro": "1",
                "supportAmex": "1",
                "supportUploadReceipt": "0",
                "maxTrans": "999"
            },
            "tsysSupportedTrans": {
                "creditSale": "1",
                "debitSale": "1",
                "forceAuth": "1",
                "creditReturn": "1",
                "debitReturn": "1",
                "reversalMenu": "1",
                "printMenu": "1",
                "moreFunctionMenu": "1",
                "authOnly": "1",
                "authIncrement": "1",
                "tipAdjust": "1",
                "capture": "1",
                "closeBatch": "1"
            }
        }
    }
}

---

Response Body

The response acknowledges the request and provides the status of the configuration push.

Parameter	Type	Description
code	Integer	The HTTP status code. 200 indicates a successful request.
msg	String	A human-readable message. success on successful requests.
timestamp	String	The UTC timestamp of the response. Format: YYYY-MM-DD HH:mm:ss.
data	Object	A container for the successful response data. Null on error.
data.pushId	String	A unique ID for this configuration push operation.
data.status	Integer	An integer code representing the status of the push. See Push Status Codes below.

Push Status Codes

Status Code	Description
0	In Progress (Parameters are being pushed)
1	Success (Parameters were pushed successfully)
2	Failure (Parameter push failed)

Success Response Example

{
    "code": 200,
    "msg": "success",
    "timestamp": "2024-08-12 14:45:54",
    "data": {
        "pushId": "768206988353077248",
        "status": 0
    }
}