Ctrlk
RegisterLogin

POI Maintenance

The POI Maintenance endpoints allow you to make partial updates to existing POI records and delete them. The Multi Merchant endpoints extend this with support for moving child POIs to a new parent and retrieving the parent POI in a multi-merchant hierarchy.

API Reference

Partial Update of a POI

This is a PATCH operation — only the fields included in the request body are updated. Omitted fields retain their current values.

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

Delete a POI

Deleting a POI is irreversible. Ensure the POI has no active orders before proceeding.

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

Multi Merchant

Multi-merchant configurations allow a single parent POI to be associated with multiple child POIs. Use these endpoints to manage that hierarchy.

Get Multi-Merchant Parent Record

Get multi merchant parent record.

get

Get the parent multi merchant POI record associated with this POI.

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
Responses
200

Multi Merchant Parent (owner) POI.

application/json
altVfiPoiIdstring · max: 12Optional

An alternative Verifone assigned identifier used for the POI within Verifone systems for transaction processing. This is also referred to as the Terminal ID (TID). This value maps to DE41 in ISO8583 specification. This identifier may also be used per contract if required.

This value is not guaranteed to be globally unique. The unique value is the internally assigned uuid - poiUid which is returned on the response.

Example: 1004631982
estateManagementIdstringOptional

This has very specific meaning as an identifier used for Estate Management. This should generally be left blank as Verifone will allocate this ID.

In VHQ this is related to the deviceId.

serialNumberstring · max: 25Optional

The serial number of the physical device

namestring · max: 35Optional

The name used to represent this POI. This is a label not an identifier.

descriptionstring · max: 30Optional

An optional value where some Merchant specific entry is associated with a POI.

statusstring · enumRequiredPossible values:
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
get
/pois/{poiUid}/parentPoi

Move Child POIs to a New Parent

This operation moves all specified child POIs to the new parent POI. Verify the target parent poiUid before executing — this action affects live terminal configuration.

Move child POIs to a new parent.

post

Move existing child POI records to a new multi merchant parent POI.

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
newParentPoiUidstring · uuidRequired

The Verifone allocated unique id for the target parent POI. This can be an existing MULTI_MERCHANT POI or an existing POINT_OF_SALE/STANDALONE POI.

If this is a POINT_OF_SALE/STANDALONE POI a new MULTI_MERCHANT POI will be created transparently based on the details from this POI. This MULTI_MERCHANT POI will be linked to the same entity as the selected POI.

Example: 04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1
Responses
200

Multi Merchant Parent POI.

application/json
altVfiPoiIdstring · max: 12Optional

An alternative Verifone assigned identifier used for the POI within Verifone systems for transaction processing. This is also referred to as the Terminal ID (TID). This value maps to DE41 in ISO8583 specification. This identifier may also be used per contract if required.

This value is not guaranteed to be globally unique. The unique value is the internally assigned uuid - poiUid which is returned on the response.

Example: 1004631982
estateManagementIdstringOptional

This has very specific meaning as an identifier used for Estate Management. This should generally be left blank as Verifone will allocate this ID.

In VHQ this is related to the deviceId.

serialNumberstring · max: 25Optional

The serial number of the physical device

namestring · max: 35Optional

The name used to represent this POI. This is a label not an identifier.

descriptionstring · max: 30Optional

An optional value where some Merchant specific entry is associated with a POI.

statusstring · enumRequiredPossible values:
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
post
/pois/{poiUid}/childPois/move
PreviousMerchant MaintenanceNextMID\TID Generation

Was this helpful?