Get Merchant Varsheet by Terminal ID

Retrieves the complete Value-Added Reseller (VAR) sheet for a specific terminal belonging to a merchant. The VAR sheet contains all parameters required to program a payment terminal, including acquirer BIN, merchant and store numbers, authorization and settlement phone numbers, debit/EBT configuration, and SSL/host-capture fields.

Endpoint

GET /api/export/Varsheet

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint when provisioning or reprogramming a payment terminal. Call GET /api/export/Terminals first to obtain the internalId for the specific terminal, then pass both the merchant id and the terminal internalId to this endpoint. The returned parameters are passed directly to terminal configuration software or a VAR to program the device.

Query Parameters

Response

200 OK

Envelope fields:

data.merchantInformation

data.vitalParameters

data.vitalPhoneNumbers (read-only)

data.debitEbt

data.authentication

data.sslFields (read-only)

data.hostCaptureFields

{
  "requestId": 304812,
  "success": true,
  "error": null,
  "validationErrors": [],
  "data": {
    "merchantInformation": {
      "name": "Acme Retail Store",
      "address": "100 Commerce Blvd",
      "city": "Miami",
      "state": "FL",
      "zip": "33101",
      "phone": "3055557890"
    },
    "vitalParameters": {
      "acquirerBin": "999001",
      "merchantNumber": "918000000001234",
      "vNumber": "79416045",
      "storeNumber": "0001",
      "terminalNumber": "0001",
      "merchantLocationNumber": "00000001",
      "merchantCategoryCode": "5999",
      "agentNumber": "000100",
      "chainNumber": "000000",
      "merchantZipCode": "33101",
      "dbaName": "ACME RETAIL",
      "merchantCity": "MIAMI",
      "merchantState": "FL",
      "timeZoneCode": "705",
      "timeZoneDifferential": "-5"
    },
    "vitalPhoneNumbers": {
      "authorization": "8004STRIPE",
      "settlement": "8004SETTLE",
      "voiceAuthorization": "8004VAUTH0"
    },
    "debitEbt": {
      "sharingGroup": "NYCE",
      "merchantAbaNumber": "021000021",
      "settleAgentNumber": "000001",
      "reimbursementAttribute": "0",
      "industry": "R",
      "fcsId": "1234567"
    },
    "authentication": {
      "authenticationCode": "A1B2C3D4"
    },
    "sslFields": {
      "portNumber": "443",
      "url": "txn.netevia.com"
    },
    "hostCaptureFields": {
      "hcPosID": "00000001"
    }
  }
}

Error Codes

Common Mistakes

• Omitting the internalId parameter — both id and internalId are required.
• Using the public merchant ID string or terminal name instead of the internal integer IDs.
• Requesting the VAR sheet for a terminal with status: Closed — closed terminals may return empty or stale programming data.
• Attempting to write or modify VAR sheet data via this endpoint — it is read-only.
• Not calling GET /api/export/Terminals first to obtain valid internalId values.

Related Endpoints

• GET /api/export/Terminals — list all terminals for a merchant to obtain internalId
• GET /api/export/MerchantProfile — retrieve full merchant data including equipment section
• GET /api/export/GetAvailableStatusesList — decode merchant status codes

Example

curl -X GET "https://hq.staging.netevia.dev/api/export/Varsheet?id=71103&internalId=10045" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"