Syntch Gateway API

PostRegister

Administration - Register Management

**Requires Authentication**
Requires any of the roles:	Merchant, Reseller

The following routes are available for this service:
POST	/registers	Creates a register for the merchant requester.

**PostRegister** Parameters:
Name	Parameter	Data Type	Required	Description
RegisterNumber	model	string	Yes	The register number.
ActivationStatus	model	ActivationStatus?	Yes	The register status. Allowable Values Pending Active
MerchantKey	query	int?	No	The merchant under which the register will exist

**ModifyRegister<T>** Parameters:
Name	Parameter	Data Type	Required	Description
RegisterName	model	string	No	The register name.
TerminalNumber	model	string	No	The terminal number.
TerminalNumber2	model	string	No	The second terminal number.
ProcessorId	model	string	Yes	The processor ID.

**ActivationStatus** Enum:
Pending
Active
Inactive
Deleted

**RegisterDetail** Parameters:
Name	Parameter	Data Type	Required	Description
RegisterKey	model	int	No	The unique identifier for this register.
MerchantKey	model	int?	No	The key of the merchant that is associated with this register.
RegisterNumber	model	string	No	The number of the register.
RegisterName	model	string	No	The name of the register.
TerminalNumber	model	string	No	The primary terminal number for the register.
TerminalNumber2	model	string	No	An additional terminal number for the register.
ProcessorId	model	string	No	Indicates the processor used by the register.
ActivationStatus	model	ActivationStatus?	No	Indicates the current activation status of the record.
LastUpdateTimestamp	model	DateTime	No	Indicates when the register was last edited.

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /registers HTTP/1.1 
Host: syntch.simpay.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RegisterNumber: String,
	ActivationStatus: Pending,
	MerchantKey: 0,
	RegisterName: String,
	TerminalNumber: String,
	TerminalNumber2: String,
	ProcessorId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	RegisterKey: 0,
	MerchantKey: 0,
	RegisterNumber: String,
	RegisterName: String,
	TerminalNumber: String,
	TerminalNumber2: String,
	ProcessorId: String,
	ActivationStatus: Pending,
	LastUpdateTimestamp: 0001-01-01
}

Syntch Gateway API

PostRegister

Allowable Values

HTTP + JSV