| Requires any of the roles: | Merchant, Reseller |
| GET | /registers/{registerKey} | Gets a register by key for the merchant requester. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RegisterKey | path | int | Yes | The key of the register to be returned. |
| 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. |
| Pending | |
| Active | |
| Inactive | |
| Deleted |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /registers/{registerKey} HTTP/1.1
Host: syntch.simpay.net
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"RegisterKey":0,"MerchantKey":0,"RegisterNumber":"String","RegisterName":"String","TerminalNumber":"String","TerminalNumber2":"String","ProcessorId":"String","ActivationStatus":"Pending","LastUpdateTimestamp":"0001-01-01T00:00:00.0000000"}