POI Maintenance
Operations to manage POI (Point of interaction/terminal) records.
Deletes a POI.
forceDelete=false (default) Deletion fails with 400 if the POI is ACTIVE. The POI must be INACTIVE before calling this endpoint.
forceDelete=true An ACTIVE POI is automatically inactivated before deletion. If already INACTIVE, deletion proceeds directly. Returns 400 if the inactivation step fails; the POI is not deleted.
The Verifone allocated unique id for this terminal/POI. This is allocated by Verifone when an order is initially received.
04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1When false (default), deletion fails with 400 if the POI is ACTIVE; the POI must be INACTIVE before calling this endpoint. When true, an ACTIVE POI is automatically inactivated before deletion; if already INACTIVE, deletion proceeds directly.
falseExample: trueThe Poi was successfully deleted.
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
DELETE /pois/{poiUid} HTTP/1.1
Host: api.verifone.com
Accept: */*
No content
A partial update of an existing POI record. Only replaces the provided parameters.
This can be used to activate/deactivate a POI record. When deactivated the terminal will be blocked from transacting.
The Verifone allocated unique id for this terminal/POI. This is allocated by Verifone when an order is initially received.
04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1An 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.
Patch POI Success.
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
PATCH /pois/{poiUid} HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"status": "ACTIVE"
}No content
Last updated
Was this helpful?