PATCH /entities/{entityUid}
A partial update of an existing Merchant Entity. Only replaces the provided parameters.
This can be used to activate/deactivate a merchant entity and change the trading name.
Servers
- https://emea.gsc.verifone.cloud/oidc/order-service
- https://us.gsc.verifone.cloud/oidc/order-service
- https://nz.gsc.verifone.cloud/oidc/order-service
- https://cst.test-gsc.vfims.com/oidc/order-service
- https://uscst-gb.gsc.vficloud.net/oidc/order-service
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
entityUid |
String | Yes |
The Verifone assigned ID corresponding to the entity. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
A name to be assigned to this entity. This can be the trading name or business name. |
status |
String | No |
An entity may have different states but will still exist in the Verifone Service without being active as a record is required for the status. This only allows update to active status, delete must be explicity executed as an operation. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.