Syntax
GET /api/updates/{id}/
Returns a JSON object that represents one update identified by its {id}. The user performing this request has to be authorized to View Vendor Company Updates. In addition to this, depending on the nature of the update the following permissions are required: View Vendor Sanction List Reports, View Tax ID Unmasked, View Vendor Payment Details and View Vendor Profiles.
Example:
GET /api/updates/30606/
Request Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| id | Number | Update identifier, for example 30606. | GET /api/updatess/30606/ will return all fields for the update 30606. |
Success Codes
| HTTP Status Code | Exception | Description |
|---|---|---|
| 200 | Success | Returns a JSON object that represents one update 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": "2022-04-12T10:48:43.055888-04: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": "Approved",
"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": {}
},
where some more important key values pairs are:
| Key | Type | Sample Value | Description |
|---|---|---|---|
| id | Number | 22584 | Each update is identified with a numeric id. |
| vendor_num | String | 12345 | If vendor that is being updated is connected, this is the id for this vendor in the ERP. |
| site_code | Array of Strings | [“1”, “2”, “3”] | This is a list of all sites for this vendor that will be affected by this update. |
| group_name | String | “Company” | What group this update belongs to: bank_address bank_account company corporate_address remittance_address order_address sanction_list_alert custom_form_fields |
| field_name | String | “Telephone” | The field that was changed. |
| from_value | String | “+12023334444” | The value prior to the change. |
| to_value | String | “+12023334445” | The new value. |
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. The client does not have access rights to the content. Unlike 401, the client’s identity is known to the server. |
| 404 | Not Found | The API that you requested does not exist on this server. |
| 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": "get_one_update",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "Token 500aXXXXXXXXXXXXXXXXXXXX6b1cf",
"type": "string"
},
{
"key": "key",
"value": "Authorization",
"type": "string"
}
]
},
"method": "GET",
"header": [],
"url": {
"raw": "https://sandbox.paymentworks.com/api/updates/30606/",
"protocol": "https",
"host": [
"sandbox",
"paymentworks",
"com"
],
"path": [
"api",
"updates",
"30606",
"details"
]
}
},
"response": []
},
Sample PostMan call:
cURL
Python
