<back to all web services
GetRegisters
Administration - Register Management
Requires Authentication
| Requires any of the roles: | Merchant, Reseller |
The following routes are available for this service:| GET | /registers | Gets a collection of registers for the merchant requester. | |
|---|
GetRegisters Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| SortField | query | string | No | The field name by which the records will be sorted. Default is 'RegisterNumber'.Allowable Values- RegisterNumber
- RegisterName
- TerminalNumber
- TerminalNumber2
- ActivationStatus
- RegisterKey
|
| IncludeDeleted | query | bool | No | Whether to include deleted records in the response, defaults to false. |
| RegisterKey | query | int? | No | Filter the customer records based on a specific customer key. |
| MerchantKey | query | int? | No | Filter the customer records based on a specific merchant key. |
SortedRequestDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| SortDirection | query | string | No | The direction in which the records will be sorted. Default is 'asc'.Allowable Values |
| SortField | query | string | No | The field name by which the records will be sorted. |
PaginatedRequestDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| PageSize | query | short | No | The number of records per page. Default is 20. |
| PageNumber | query | short | No | The page number to fetch. Default is 1. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /registers HTTP/1.1
Host: syntch.simpay.net
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfRegisterDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Registers.Responses">
<RegisterDetail>
<ActivationStatus>Pending</ActivationStatus>
<LastUpdateTimestamp>0001-01-01T00:00:00</LastUpdateTimestamp>
<MerchantKey>0</MerchantKey>
<ProcessorId>String</ProcessorId>
<RegisterKey>0</RegisterKey>
<RegisterName>String</RegisterName>
<RegisterNumber>String</RegisterNumber>
<TerminalNumber>String</TerminalNumber>
<TerminalNumber2>String</TerminalNumber2>
</RegisterDetail>
</ArrayOfRegisterDetail>