Configure TSYS Host Processor

isActive	boolean Indicates whether the merchant's TSYS Host Processor Account is active or not.
mid	string [ 1 .. 32 ] characters The unique merchant identification number assigned by TSYS.
bin	string = 6 characters The bank identification number associated with the merchant's account.
amexNumber	string [ 1 .. 32 ] characters The American Express identification number for the merchant.
amexOptBlue	string [ 1 .. 32 ] characters The American Express OptBlue identification number for the merchant, if they participate in the OptBlue program.
association	string [ 1 .. 64 ] characters The card association with which the merchant is associated, such as Visa, Mastercard, or American Express.
industry	string The industry the merchant belongs to, which determines the transaction types and processing rules. Enum: "moto" "eCommerce" "retail"
mcc	string = 4 characters The four-digit merchant category code that classifies the merchant's business based on the goods or services provided.
bankNumber	string [ 1 .. 32 ] characters The unique identifier for the bank that is associated with the merchant's account.
discoverNumber	string [ 1 .. 32 ] characters The Discover identification number for the merchant.
url	string <URL> The URL for the TSYS Host Processor used for transaction processing and communication.
settlementTime	string <date-time> The time at which the settlement process occurs, typically in the format "HH:mm:ss".

object

merchantName	string [ 1 .. 128 ] characters The name of the merchant's company.
merchantPhoneNumber	string [ 10 .. 15 ] characters The merchant's contact phone number.
address1	string [ 1 .. 128 ] characters The first line of the merchant's address.
address2	string <= 128 characters The second line of the merchant's address, if applicable.
city	string [ 1 .. 64 ] characters The city in which the merchant's company is located.
state	string = 2 characters The state in which the merchant's company is located.
zip	string [ 5 .. 10 ] characters The ZIP code for the merchant's company location.
country	string The country in which the merchant's company is located. Value: "USA"

object

agentBank	string [ 1 .. 32 ] characters The unique identifier for the agent bank that is associated with the merchant's account.
chain	string [ 1 .. 32 ] characters The chain identifier associated with the merchant's account, if applicable.
storeNumber	string [ 1 .. 32 ] characters The store number associated with the merchant's account, if applicable.
mvv	string [ 1 .. 32 ] characters The merchant verification value, which is a unique identifier for the merchant's point-of-sale (POS) system.
terminalId	string [ 1 .. 32 ] characters The unique identifier for the terminal or point-of-sale device used by the merchant.
terminalNumber	string [ 1 .. 32 ] characters The terminal number associated with the merchant's account, if applicable.

object (CustomPropertiesInput)

An object containing user-defined key/value pairs.

property name*

additional property

string

Responses

200

400

Bad Request

401

Unauthorized access

403

Access forbidden

404

Resource was not found

409

Conflict.

429

Too Many Requests

post/hostConfiguration/tsys

Request samples

{"tsysHost": {"general": {"isActive": true,
"mid": "123456789",
"bin": "654321",
"amexNumber": "123456",
"amexOptBlue": "654321",
"association": "Visa",
"industry": "eCommerce",
"mcc": "5812",
"bankNumber": "BANK9876",
"discoverNumber": "789123",
"url": "https://example.tsyshost.com",
"settlementTime": "23:00:00"
},
"merchant": {"merchantName": "Example Company Inc.",
"merchantPhoneNumber": "555-123-4567",
"address1": "123 Main St",
"address2": "Suite 456",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
},
"agentNumber": {"agentBank": "AGENT1234",
"chain": "CHAIN5678",
"storeNumber": "STORE9012",
"mvv": "MVV3456",
"terminalId": "TERMINAL1234",
"terminalNumber": "TERM7890"
},
"userDefinedFields": {"custom_field1": "Custom value 1",
"custom_field2": "Custom value 2"
}
}
}

Response samples

{"tsysHostDetails": {"general": {"isActive": true,
"mid": "123456789",
"bin": "654321",
"amexNumber": "123456",
"amexOptBlue": "654321",
"association": "Visa",
"industry": "eCommerce",
"mcc": "5812",
"bankNumber": "BANK9876",
"discoverNumber": "789123",
"url": "https://example.tsyshost.com",
"settlementTime": "23:00:00"
},
"merchant": {"merchantName": "Example Company Inc.",
"merchantPhoneNumber": "555-123-4567",
"address1": "123 Main St",
"address2": "Suite 456",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
},
"agentNumber": {"agentBank": "AGENT1234",
"chain": "CHAIN5678",
"storeNumber": "STORE9012",
"mvv": "MVV3456",
"terminalId": "TERMINAL1234",
"terminalNumber": "TERM7890"
},
"userDefinedFields": {"property1": "string",
"property2": "string"
}
},
"referenceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"cryptoKeys": {"deviceEncryptionKey": "7625e224dc0f0ec91ad28c1ee67b1eb96d1a5459533c5c950f44aae1e32f2da3",
"transactionEncryptionKey": "aafeeba6959ebeeb96519d5dcf0bcc069f81e4bb56c246d04872db92666e6d4b"
}
}

Configure TSYS Host Processor

header Parameters

Request Body schema: application/UNENCRYPTED—DO_NOT_SEND+jsonapplication/jsonapplication/UNENCRYPTED—DO_NOT_SEND+json

Request Body schema:
application/UNENCRYPTED—DO_NOT_SEND+json