<back to all web services
PatchRegister
Administration - Register Management
Requires Authentication
| Requires any of the roles: | Merchant, Reseller |
The following routes are available for this service:| PATCH | /registers/{registerKey} | Updates a register for the merchant requester with only the data provided. | |
|---|
PatchRegister Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| RegisterKey | path | int | Yes | The key of the custom field to be edited. |
| ActivationStatus | model | string | No | The register status.Allowable Values- Pending
- Active
- Inactive
- Deleted
|
| Status | query | ActivationStatus? | No | |
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 .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.
PATCH /registers/{registerKey} HTTP/1.1
Host: syntch.simpay.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PatchRegister xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Registers.Requests">
<ProcessorId>String</ProcessorId>
<RegisterName>String</RegisterName>
<TerminalNumber>String</TerminalNumber>
<TerminalNumber2>String</TerminalNumber2>
<ActivationStatus>String</ActivationStatus>
<RegisterKey>0</RegisterKey>
</PatchRegister>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RegisterDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Registers.Responses">
<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>