v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB

POI Maintenance

Delete a Single POI

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.

delete/pois/{poiUid}

Path parameters

poiUidstring uuid required

The Verifone allocated unique id for this terminal/POI. This is allocated by Verifone when an order is initially received.

The assigned ID corresponding for the POI.

Query parameters

forceDeleteboolean

When 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.

Response

The Poi was successfully deleted.