PATCH api/alternateprocessors/{id}
This endpoint allows modification of a global alternate processor .
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID of the alternate processor to update. |
integer |
Required |
Body Parameters
The JSON Patch document containing the changes.
JsonPatchDocument| Name | Description | Type | Additional information |
|---|---|---|---|
| Operations | Collection of Operation |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/json-patch+json
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns the updated alternate processor model if successful; otherwise, returns an error message.
AlternateProcessorModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AlternateProcessorVendorUrl | string |
None. |
|
| AlternateProcessorVendorNo | integer |
None. |
|
| Description | string |
None. |
|
| Bin | string |
None. |
|
| PCN | string |
None. |
|
| GroupID | string |
None. |
|
| ApproveMessage | string |
None. |
|
| APIKey | string |
None. |
|
| OAuthClientID | string |
None. |
|
| OAuthClientSecret | string |
None. |
|
| ClientID | string |
None. |
|
| Active | boolean |
None. |
|
| AllowPartialFills | boolean |
None. |
|
| Url |
Gets or sets the link representing a link back to the resource |
string |
None. |
| ID |
Gets or sets the identifier for the resource |
integer |
None. |
Response Formats
application/json, text/json, application/json-patch+json
Sample:
{
"url": "sample string 15",
"id": 16,
"alternateProcessorVendorUrl": "sample string 3",
"alternateProcessorVendorNo": 4,
"description": "sample string 5",
"bin": "sample string 6",
"pcn": "sample string 7",
"groupID": "sample string 8",
"approveMessage": "sample string 9",
"apiKey": "sample string 10",
"oAuthClientID": "sample string 11",
"oAuthClientSecret": "sample string 12",
"clientID": "sample string 13",
"active": true,
"allowPartialFills": true
}