Get VAR Sheets

Returns every VAR sheet for one merchant, addressed by MID.

A VAR sheet carries the identifiers a payment gateway needs in order to route the merchant's transactions to the processor. This endpoint returns them as JSON so you can read them into your own systems instead of requesting a spreadsheet.

Merchants board through one of two flows, and the two produce different documents. Read the processor field first, then parse var_sheets accordingly:

  • tsys — one entry per boarded terminal, each carrying the 22 VAR sheet fields. A merchant with several terminals returns several entries, so always treat var_sheets as a list.
  • fiserv — one entry per outlet, passed through from the boarding platform. The terminals sit in terminal_setup_information.

Gateway notes

For NMI: the gateway's Merchant Number is pos_merchant_id, the Location Code is zip_code, and the Vital Number is v_number with the leading V replaced by a 7 (so V7000001 is entered as 77000001).

For Authorize.net: mcc must match the value configured in the gateway or transactions will fail.

Access

You can only read merchants under your own account. A MID belonging to another partner returns the same 404 as a MID that does not exist.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 50

The merchant's MID.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json