Change Update Status to Processed
Syntax
PATCH /api/updates/{id}
body = {"status": "3"}
To change the status from Approved to Processed of an Update identified by {id} add a body to the request that will have one key pair: "status": "3" . This API call is idempotent. The id of the Update needs to be part of the API URL. The user performing this request has to be authorized to Change Vendor Update Status.
Example:
GET /api/updates/20100/
body = {"status": "3"}
Request Parameters
This API does not take any parameters.
Success Codes
| HTTP Status Code | Exception | Description |
|---|---|---|
| 200 | Success | Returns a JSON object that contains select set of fields for a vendor identified by its {id}. |
Sample Response
Returns a JSON object that contains all fields for a particular update. Example:
{
"id": 22584,
"ts": "2022-04-12T10:44:25.474805-04:00",
"status_ts": "2023-02-24T13:19:54.387511-05:00",
"vendor_nums": [
{
"site_codes": [
"2"
],
"vendor_num": "12345"
}
],
"vendor_name": "Home depot of Wolcott",
"group_name": "Company",
"from_value_display": "Telephone: +12023334444",
"to_value_display": "Telephone: +12023334445",
"status": "Processed",
"field_changes": [
{
"field_name": "Telephone",
"from_value": "+12023334444",
"to_value": "+12023334445"
}
],
"user_can_approve": false,
"pending_approvers": [],
"user_can_skip": false,
"user_can_bypass": false,
"addr_validated": null,
"bank_validation_status_display": "",
"bank_verification_reason_context": null,
"bank_verification_note": null,
"metadata": {}
},
Error Codes
| HTTP Status Code | Exception | Description |
|---|---|---|
| 400 | Bad Request | The request could not be understood by the server due to incorrect syntax. |
| 401 | Unauthenticated | The request requires user authentication information. Your API token is missing or invalid. |
| 403 | Forbidden | Unauthorized request. Cannot change status of an update that does not belong to your account, or user does not have permissions to change the status of an update. |
| 404 | Not Found | Cannot change status of a non-existent update. |
| 500
503 | Service Unavailable | The request has failed due to a temporary failure of the server. You can try this request at a later time. |
Calling the API
Postman
Call Syntax:
{
"name": "update_change_status",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "Token 500aXXXXXXXXXXXXXXXXXXXb1cf",
"type": "string"
},
{
"key": "key",
"value": "Authorization",
"type": "string"
}
]
},
"method": "PATCH",
"header": [],
"body": {
"mode": "raw",
"raw": "{n "status": "3"n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.paymentworks.com/api/updates/16201/",
"protocol": "https",
"host": [
"sandbox",
"paymentworks",
"com"
],
"path": [
"api",
"updates",
"16201",
""
]
}
},
"response": []
},
Sample PostMan call:
cURL
Python
