Add terminal and get VAR Sheet
The Add Terminal and Get VAR Sheet API allows partners to add a terminal for a merchant and retrieve the merchant's full profile, including the VAR (Value-Added Reseller) sheet. These APIs ensure that the terminal setup is complete and the merchant profile is fully accessible.
Key Features:
- Add Terminal: Easily add a terminal for a merchant, with details about the terminal status and ID returned in the response.
- Retrieve Merchant Profile: Export the full merchant profile, including equipment and VAR sheet information, ensuring complete visibility into the merchant’s terminal setup and profile data.
- [POST] /api/v1/merchant/stageOnlyTerminal - Adding a terminal for the merchant
- [GET] /api/export/MerchantProfile - Get full merchant profile including equipment (with VAR Sheet)
Request [POST] /api/v1/merchant/stageOnlyTerminal:
| Parameter Name | Type | Required | Description | Validation | Example Example Values |
|---|---|---|---|---|---|
| ID MerchantProfile | TsysMerchant | TsysMerchant | Merchant profile id from submit response | Only digits | 12 |
Response [POST] /api/v1/merchant/stageOnlyTerminal:
{
"terminalId": 456,
"status": "New",
"requestId": 123,
"success": true
}
Request [GET] /api/export/MerchantProfile:
| Parameter Name | Type | Required | Description | Validation | Example Example Values |
|---|---|---|---|---|---|
| ID MerchantProfile | TsysMerchant | TsysMerchant | Merchant profile id from submit response | Only digits | 12 |
Response [GET] /api/export/MerchantProfile:
{
"merchantStatus": {
"internalMid": 0,
"merchantId": "string",
"lastModified": "2024-09-17T06:50:56.941Z",
"status": 0,
"statusDate": "2024-09-17T06:50:56.941Z",
"uwComment": "string"
},
"merchant": {
"merchantProfile": {
"smallMerchFlag": true,
"cashDiscount": "No",
"agentProfileId": 0,
"pos": "None",
"boardingSettingsId": 0,
"mid": "string"
},
"businessAndOwnerInformation": {
"customerServicePhoneNum": "string",
"federalTaxId": "string",
"dateOfStartBusiness": "2024-09-17T06:50:56.941Z",
"merchantEmail": "string",
"merchantWebsite": "string",
"multipleLocations": true,
"numOfLocations": 0,
"legalAddress": {
"name": "string",
"address": "string",
"postalCode": "string",
"city": "string",
"state": "Alaska",
"phone": "string",
"fax": "string"
},
"dbaAddress": {
"name": "string",
"address": "string",
"postalCode": "string",
"city": "string",
"state": "Alaska",
"phone": "string",
"fax": "string"
},
"primaryOwner": {
"firstName": "string",
"lastName": "string",
"dateOfBirth": "2024-09-17T06:50:56.941Z",
"ssn": "string",
"address": "string",
"city": "string",
"state": "Alaska",
"zip": "string",
"homePhone": "string",
"title": "President",
"ownership": 0,
"email": "string",
"guarantor": true,
"typeOfIssuedID": "USPassport",
"idNumber": "string",
"idExpirationDate": "2024-09-17T06:50:56.941Z"
},
"secondaryOwner": {
"firstName": "string",
"lastName": "string",
"dateOfBirth": "2024-09-17T06:50:56.941Z",
"ssn": "string",
"address": "string",
"city": "string",
"state": "Alaska",
"zip": "string",
"homePhone": "string",
"title": "President",
"ownership": 0,
"email": "string",
"guarantor": true,
"typeOfIssuedID": "USPassport",
"idNumber": "string",
"idExpirationDate": "2024-09-17T06:50:56.941Z"
},
"owner3": {
"firstName": "string",
"lastName": "string",
"dateOfBirth": "2024-09-17T06:50:56.941Z",
"ssn": "string",
"address": "string",
"city": "string",
"state": "Alaska",
"zip": "string",
"homePhone": "string",
"title": "President",
"ownership": 0,
"email": "string",
"guarantor": true,
"typeOfIssuedID": "USPassport",
"idNumber": "string",
"idExpirationDate": "2024-09-17T06:50:56.941Z"
},
"owner4": {
"firstName": "string",
"lastName": "string",
"dateOfBirth": "2024-09-17T06:50:56.941Z",
"ssn": "string",
"address": "string",
"city": "string",
"state": "Alaska",
"zip": "string",
"homePhone": "string",
"title": "President",
"ownership": 0,
"email": "string",
"guarantor": true,
"typeOfIssuedID": "USPassport",
"idNumber": "string",
"idExpirationDate": "2024-09-17T06:50:56.941Z"
},
"controllingOfficer1": {
"dateOfBirth": "2024-09-17T06:50:56.941Z",
"ssn": "string",
"firstName": "string",
"lastName": "string",
"title": "President",
"address": "string",
"zip": "string",
"city": "string",
"state": "Alaska",
"homePhone": "string",
"typeOfIssuedID": "USPassport",
"idNumber": "string",
"idExpirationDate": "2024-09-17T06:50:56.942Z",
"guarantor": true
},
"controllingOfficer2": {
"dateOfBirth": "2024-09-17T06:50:56.942Z",
"ssn": "string",
"firstName": "string",
"lastName": "string",
"title": "President",
"address": "string",
"zip": "string",
"city": "string",
"state": "Alaska",
"homePhone": "string",
"typeOfIssuedID": "USPassport",
"idNumber": "string",
"idExpirationDate": "2024-09-17T06:50:56.942Z",
"guarantor": true
}
},
"salesAndBusinessProfile": {
"sic": "string",
"sellingRegulatedSubstances": true,
"massageServices": true,
"sellingGasFuel": true,
"typeOfOwnership": "Corporation",
"businessType": "Other",
"accountType": "C",
"accountNumber": "string",
"businessCheckingRoutingNumber": "string",
"achMethod": "Combine",
"averageTicket": 0,
"highTicket": 0,
"salesToConsumers": 0,
"salesToBusiness": 0,
"salesToGovernment": 0,
"bankName": "string",
"goodsAndServices": "string",
"returnPolicy": "string",
"nextDayFunding": true,
"sameDayFunding": true,
"isVsMcDsNetwork": true,
"monthlyVolume": 0,
"annualVolume": 0,
"retail": 0,
"imprint": 0,
"moto": 0,
"internet": 0,
"cardNotPresentInformation": {
"isWebHosting": true,
"isDomainRegistration": true,
"isWebPageDesign": true,
"isAuction": true,
"isInternetServiceGateway": true,
"isSellingDigitalService": true,
"isAdvertisement": true,
"isSellingHardGoods": true,
"isOther": true,
"otherInternetBusinessType": "string",
"advertiseOrPromotion": "string",
"secureTransactionInformation": "string",
"vendors": "string",
"productFulfillment": "string",
"saleDescription": "string",
"monthly": 0,
"yearly": 0,
"quarterly": 0,
"oneTime": 0,
"hourly": 0,
"isMonthly": true,
"isYearly": true,
"isQuarterly": true,
"isOneTime": true,
"isHourly": true
}
},
"siteInspection": {
"inventoryMaintainedType": "OnSite",
"fulfillmentCenterNameAndAddress": "string",
"question1": true,
"question1Explanation": "string",
"question2": true,
"question2Explanation": "string",
"question3": true,
"question3Explanation": "string",
"question4": true,
"question4Explanation": "string",
"zoning": "Comml",
"squareFootageType": "From_0_To_500",
"squareFootageTypeOther": 0,
"merchant": "Owns",
"nameAddressLandlord": "string"
},
"serviceAcceptance": {
"amexESA": true,
"amexOptBlue": true,
"discover": true,
"payPal": true,
"jcb": true,
"ebt": true,
"debitCard": true,
"amexNumber": "string",
"fcsNumber": "string"
},
"fees": {
"minimumDiscountAmount": 0,
"minimumDiscountStartDate": "2024-09-17T06:50:56.942Z",
"minimumDiscountType": "Daily",
"earlyTerminationFeeAmount": 0,
"earlyTerminationFeeContractMonths": 0,
"amex": {
"interchangePlus": {
"qualifiedDiscount": {
"perItem": 0,
"percent": 0
}
},
"tieredDiscounts": {
"qualifiedDiscount": {
"perItem": 0,
"percent": 0
},
"midQual": {
"perItem": 0,
"percent": 0
},
"nonQual": {
"perItem": 0,
"percent": 0
}
},
"noSurcharge": {
"qualDiscount": {
"discountType": "Daily",
"perItem": 0,
"percent": 0
}
},
"amexInterchangePlusPlus": {
"qualifiedDiscount": {
"perItem": 0,
"percent": 0
},
"midQual": {
"perItem": 0,
"percent": 0
},
"nonQual": {
"perItem": 0,
"percent": 0
}
}
},
"visaMasterCardDiscover": {
"billBackIntrDifferential": {
"vsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"vsQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"vsNonQualICDiff": {
"perItem": 0,
"percent": 0
},
"mcNonQualICDiff": {
"perItem": 0,
"percent": 0
},
"dsNonQualICDiff": {
"perItem": 0,
"percent": 0
},
"axNonQualICDiff": {
"perItem": 0,
"percent": 0
}
},
"interchangePlus": {
"vsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"vsQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualDbDiscount": {
"perItem": 0,
"percent": 0
}
},
"noSurcharge": {
"vsQualCrDiscount": {
"discountType": "Daily",
"perItem": 0,
"percent": 0
},
"vsQualDbDiscount": {
"discountType": "Daily",
"perItem": 0,
"percent": 0
},
"mcQualCrDiscount": {
"discountType": "Daily",
"perItem": 0,
"percent": 0
},
"mcQualDbDiscount": {
"discountType": "Daily",
"perItem": 0,
"percent": 0
},
"dsQualCrDiscount": {
"discountType": "Daily",
"perItem": 0,
"percent": 0
},
"dsQualDbDiscount": {
"discountType": "Daily",
"perItem": 0,
"percent": 0
}
},
"tieredDiscountsMOTOEcomm": {
"vsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"vsQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"midMOTO": {
"perItem": 0,
"percent": 0
},
"nonQual": {
"perItem": 0,
"percent": 0
}
},
"tieredDiscountsRetail": {
"vsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"vsQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"midQual": {
"perItem": 0,
"percent": 0
},
"nonQual": {
"perItem": 0,
"percent": 0
}
},
"customInterchange": {
"vcMcDsInterSurcharge": {
"perItem": 0,
"percent": 0
},
"vsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"vsQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualDbDiscount": {
"perItem": 0,
"percent": 0
}
},
"customInterchangeDurbin": {
"interSurcharge": {
"perItem": 0,
"percent": 0
},
"interNonSurcharge": {
"perItem": 0,
"percent": 0
},
"regulatedDbSurcharge": {
"perItem": 0,
"percent": 0
},
"vsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"vsQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"mcQualDbDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualCrDiscount": {
"perItem": 0,
"percent": 0
},
"dsQualDbDiscount": {
"perItem": 0,
"percent": 0
}
},
"interchangePlusPlus": {
"qualifiedDiscount": {
"perItem": 0,
"percent": 0
},
"midQual": {
"perItem": 0,
"percent": 0
},
"nonQual": {
"perItem": 0,
"percent": 0
}
}
},
"authorizationMonthlyAndSpecialProgram": {
"vsmcdiscAuth": {
"perItem": 0,
"percent": 0
},
"amexAuth": {
"perItem": 0,
"percent": 0
},
"avs": {
"perItem": 0,
"percent": 0
},
"batch": {
"perItem": 0,
"percent": 0
},
"voiceAuthorization": {
"perItem": 0,
"percent": 0
},
"retrieval": {
"perItem": 0,
"percent": 0
},
"chargeback": {
"perItem": 0,
"percent": 0
},
"chargebackViolation": {
"perItem": 0,
"percent": 0
},
"achReject": {
"perItem": 0,
"percent": 0
},
"merchAnnual": {
"perItem": 0,
"percent": 0
},
"statement": {
"perItem": 0,
"percent": 0
},
"reporting1099K": {
"perItem": 0,
"percent": 0
},
"tinMismatch": {
"perItem": 0,
"percent": 0
},
"pciAnnual": {
"perItem": 0,
"percent": 0
},
"pciNonCompliance": {
"perItem": 0,
"percent": 0
},
"pciMonthly": {
"perItem": 0,
"percent": 0
},
"pciQuarterly": {
"perItem": 0,
"percent": 0
}
},
"standard": {
"dialPay": {
"perItem": 0,
"percent": 0
},
"onlinePortal": {
"perItem": 0,
"percent": 0
},
"motoEcommSurchargePI": {
"perItem": 0,
"percent": 0
},
"nextDayFunding": {
"perItem": 0,
"percent": 0
},
"sameDayFunding": {
"perItem": 0,
"percent": 0
}
},
"debitPinAndEBT": {
"pinDebitMonthly": {
"perItem": 0,
"percent": 0
},
"pinDebitQualifiedDiscount": {
"discountType": "Daily",
"perItem": 0,
"percent": 0
},
"pinDebitAuth": {
"discountType": "Daily",
"perItem": 0,
"percent": 0
},
"pinDebitAnnual": {
"perItem": 0,
"percent": 0
},
"ebtTrans": {
"perItem": 0,
"percent": 0
}
},
"gatewayProducts": {
"micros": {
"perItem": 0,
"percent": 0
},
"wirelessAndMobilePOSPI": {
"perItem": 0,
"percent": 0
},
"gatewayAccess": {
"perItem": 0,
"percent": 0
},
"gatewayPerItem": {
"perItem": 0,
"percent": 0
},
"wirelessActivation": {
"perItem": 0,
"percent": 0
},
"wirelessAccess": {
"perItem": 0,
"percent": 0
},
"unifiedmPOSActivation": {
"perItem": 0,
"percent": 0
},
"unifiedmPOSAccess": {
"perItem": 0,
"percent": 0
},
"unifiedmPOSTransactions": {
"perItem": 0,
"percent": 0
}
},
"miscFees": [
{
"name": "string",
"stopDate": "2024-09-17T06:50:56.944Z",
"startDate": "2024-09-17T06:50:56.944Z",
"frequency": "Annual",
"month": 0,
"year": 0,
"perItem": 0,
"percent": 0
}
],
"miscFeesVolume": [
{
"name": "string",
"stopDate": "2024-09-17T06:50:56.944Z",
"startDate": "2024-09-17T06:50:56.944Z",
"frequency": "Annual",
"month": 0,
"year": 0,
"perItem": 0,
"percent": 0
}
]
},
"equipment": {
"terminals": [
{
"internalId": 0,
"name": "string",
"terminalType": 0,
"status": "New",
"creationDate": "2024-09-17T06:50:56.944Z",
"varsheet": {
"vNumber": "string",
"agent": "string",
"chain": "string",
"terminalNumber": "string",
"storeNumber": "string",
"merchantName": "string",
"merchantNumber": "string",
"merchantInformation": {
"city": "string",
"state": "string",
"postalCode": "string",
"phoneNumber": "string",
"country": "string",
"currencyCode": "string",
"timeZoneCode": "string",
"timeZoneDifferential": "string",
"visaMcc": "string",
"industry": "string",
"cardTypeAccepted": {
"masterCard": "string",
"jcbCard": "string",
"visa": "string",
"americanExpress": "string",
"discoverCard": "string"
}
}
}
}
]
}
},
"merchantStatusHistory": [
{
"status": 0,
"statusDate": "2024-09-17T06:50:56.944Z",
"uwComment": "string"
}
]
}
Updated 12 days ago