| Requires any of the roles: | Merchant, Reseller |
| GET | /registers | Gets a collection of registers for the merchant requester. |
|---|
| 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
|
| 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. |
| 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. |
| 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 .jsv suffix or ?format=jsv
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: text/jsv
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
}
]