Mint a TSYS VAR sheet

Mint a TSYS VAR Sheet for a Line Item

curl --request POST \
  --url https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "terminalNumber": "0002",
  "midId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet"

payload = {
    "terminalNumber": "0002",
    "midId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({terminalNumber: '0002', midId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'terminalNumber' => '0002',
    'midId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet"

	payload := strings.NewReader("{\n  \"terminalNumber\": \"0002\",\n  \"midId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"terminalNumber\": \"0002\",\n  \"midId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"terminalNumber\": \"0002\",\n  \"midId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderType": "placement",
  "deploymentModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionType": [
    "ip"
  ],
  "status": "pending",
  "inventoryUnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "equipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "varsheetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "<string>",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inventoryUnit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deploymentModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serialNumber": "<string>",
    "condition": "new",
    "status": "available",
    "receivedDate": "<string>",
    "createdAt": "<string>",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "<string>",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "equipment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entityType": "lead",
    "deploymentModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "inventoryUnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendorTerminalId": "<string>",
    "varsheetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "provisioning",
    "deployedDate": "<string>",
    "createdAt": "<string>",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "<string>",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modelName": "<string>",
    "equipmentType": "terminal",
    "serialNumber": "<string>"
  },
  "varsheet": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entityType": "lead",
    "midId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vNumber": "<string>",
    "terminalIdNumber": "<string>",
    "agent": "<string>",
    "chain": "<string>",
    "storeNumber": "<string>",
    "merchantNumber": "<string>",
    "currencyCode": "<string>",
    "timeZoneCode": "<string>",
    "timeZoneDifferential": "<string>",
    "discoverNumber": "<string>",
    "amexOptBlue": true,
    "pinDebit": true,
    "ebtFoodStamps": true,
    "ebtCash": true,
    "merchantLocationNumber": "<string>",
    "merchantABANumber": "<string>",
    "merchantSettlementAgent": "<string>",
    "reimbursementAttribute": "<string>",
    "sharingGroup": "<string>",
    "industry": "<string>",
    "fcsNumber": "<string>",
    "createdAt": "<string>",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "<string>",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "shipment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "carrierCode": "<string>",
    "trackingNumber": "<string>",
    "shippedDate": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

POST

crm

deployment-orders

{orderId}

line-items

{lineItemId}

mint-varsheet

Mint a TSYS VAR Sheet for a Line Item

curl --request POST \
  --url https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "terminalNumber": "0002",
  "midId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet"

payload = {
    "terminalNumber": "0002",
    "midId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({terminalNumber: '0002', midId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'terminalNumber' => '0002',
    'midId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet"

	payload := strings.NewReader("{\n  \"terminalNumber\": \"0002\",\n  \"midId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"terminalNumber\": \"0002\",\n  \"midId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/crm/deployment-orders/{orderId}/line-items/{lineItemId}/mint-varsheet")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"terminalNumber\": \"0002\",\n  \"midId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderType": "placement",
  "deploymentModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionType": [
    "ip"
  ],
  "status": "pending",
  "inventoryUnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "equipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "varsheetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "<string>",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inventoryUnit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deploymentModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serialNumber": "<string>",
    "condition": "new",
    "status": "available",
    "receivedDate": "<string>",
    "createdAt": "<string>",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "<string>",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "equipment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entityType": "lead",
    "deploymentModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "inventoryUnitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendorTerminalId": "<string>",
    "varsheetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "provisioning",
    "deployedDate": "<string>",
    "createdAt": "<string>",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "<string>",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modelName": "<string>",
    "equipmentType": "terminal",
    "serialNumber": "<string>"
  },
  "varsheet": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entityType": "lead",
    "midId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vNumber": "<string>",
    "terminalIdNumber": "<string>",
    "agent": "<string>",
    "chain": "<string>",
    "storeNumber": "<string>",
    "merchantNumber": "<string>",
    "currencyCode": "<string>",
    "timeZoneCode": "<string>",
    "timeZoneDifferential": "<string>",
    "discoverNumber": "<string>",
    "amexOptBlue": true,
    "pinDebit": true,
    "ebtFoodStamps": true,
    "ebtCash": true,
    "merchantLocationNumber": "<string>",
    "merchantABANumber": "<string>",
    "merchantSettlementAgent": "<string>",
    "reimbursementAttribute": "<string>",
    "sharingGroup": "<string>",
    "industry": "<string>",
    "fcsNumber": "<string>",
    "createdAt": "<string>",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "<string>",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "shipment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "carrierCode": "<string>",
    "trackingNumber": "<string>",
    "shippedDate": "<string>"
  }
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Enter token in following format: Bearer

Path Parameters

orderId

string

required

lineItemId

string

required

Body

application/json

terminalNumber

string

required

Pattern: ^\d{1,4}$

Example:

"0002"

midId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

The line item, with its newly minted VAR sheet.

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

orderId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

orderType

enum<string>

required

Available options:

placement,

lease,

rental,

sale,

reprogram,

var_only,

warranty_swap,

gateway,

gateway_var_only,

pos_var_only,

terminal_var_only

deploymentModelId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

connectionType

enum<string>[] | null

required

Available options:

ip,

wifi,

gprs,

ios,

android

status

enum<string>

required

Available options:

pending,

allocated,

provisioned,

shipped,

delivered,

deployed,

returned,

canceled

inventoryUnitId

string<uuid> | null

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

equipmentId

string<uuid> | null

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

varsheetId

string<uuid> | null

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

createdAt

string

required

createdBy

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

updatedAt

string

required

updatedBy

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

inventoryUnit

object | null

Show child attributes

equipment

object | null

Show child attributes

varsheet

object | null

Show child attributes

shipment

object | null

Show child attributes

API Reference

Agents

Applications

Deployments

Merchants

Partners

Reporting

Tickets

Authorizations

Path Parameters

Body

Response