Ctrlk
RegisterLogin
For the complete documentation index, see llms.txt. This page is also available as Markdown.

POI Maintenance

Operations to manage POI (Point of interaction/terminal) records.

Delete a Single POI

delete

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.

Path parameters
poiUidstring · uuidRequired

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

Example: 04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1
Query parameters
forceDeletebooleanOptional

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.

Default: falseExample: true
Responses
delete
/pois/{poiUid}
No content

Partial Update of a POI

patch

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.

Path parameters
poiUidstring · uuidRequired

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

Example: 04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1
Body
statusstring · enumOptional

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.

Possible values:
Responses
patch
/pois/{poiUid}
No content
PreviousHardware OrdersNextMerchant Maintenance

Last updated

Was this helpful?