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/Terminals - Get all merchant terminals
- [GET] /api/export/Varsheet - Get VarSheet by terminal id
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/Terminals:
| 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/Terminals:
{
"data": [
{
"internalId": 0,
"name": "string",
"terminalType": 0,
"status": "New",
"creationDate": "2025-09-10T14:52:18.735Z"
}
],
"requestId": 0,
"success": true
}Request [GET] /api/export/Varsheet:
| Parameter Name | Type | Required | Description | Validation | Example Example Values |
|---|---|---|---|---|---|
| ID MerchantProfile | TsysMerchant | True | Merchant profile id from submit response | Only digits | 12 |
| InternalId | internalId | True | internalId from list terminals | Only digits | 12 |
Response [GET] /api/export/Varsheet:
{
"data": {
"merchantInformation": {
"name": "string",
"address": "string",
"city": "string",
"state": "string",
"zip": "string",
"phone": "string"
},
"vitalParameters": {
"acquirerBin": "string",
"merchantNumber": "string",
"vNumber": "string",
"storeNumber": "string",
"terminalNumber": "string",
"merchantLocationNumber": "string",
"merchantCategoryCode": "string",
"agentNumber": "string",
"chainNumber": "string",
"merchantZipCode": "string",
"dbaName": "string",
"merchantCity": "string",
"merchantState": "string",
"timeZoneCode": "string",
"timeZoneDifferential": "string"
},
"vitalPhoneNumbers": {
"authorization": "string",
"settlement": "string",
"voiceAuthorization": "string"
},
"debitEbt": {
"sharingGroup": "string",
"merchantAbaNumber": "string",
"settleAgentNumber": "string",
"reimbursementAttribute": "string",
"industry": "string",
"fcsId": "string"
},
"authentication": {
"authenticationCode": "string"
},
"sslFields": {
"portNumber": "string",
"url": "string"
},
"hostCaptureFields": {
"hcPosID": "string"
}
},
"requestId": 0,
"success": true,
"error": "string",
"validationErrors": [
{
"field": "string",
"error": "string"
}
]
}Updated 7 days ago