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

POI Maintenance

The POI Maintenance endpoints let you look up POI UIDs, make partial updates to existing POI records, and delete them. For multi-merchant hierarchy endpoints, see Multi Merchant.

API Reference

Lookup POIs by merchant identifiers

Resolves POI UIDs from one or more merchant identifiers. At least one query parameter must be provided.

Parameters are grouped into three resolution paths:

  • Path 1: merchantId

  • Path 2: entity identifiers — AND-combinable

  • Path 3: estateManagementId

merchantId + altVfiEntityId is also supported.

Lookup POIs by merchant identifiers

get

Resolves POI UIDs from one or more merchant identifiers. At least one query parameter must be provided. Parameters are grouped into three resolution paths: Path 1 (merchantId), Path 2 (entity identifiers — AND-combinable), Path 3 (estateManagementId). merchantId + altVfiEntityId is also supported.

Query parameters
merchantIdstringOptional

Acquirer MID stored on Payment Provider Contract (Path 1).

altVfiEntityIdstringOptional

Verifone gateway MID (ISO8583 DE42) (Path 2).

siteReferenceIdstringOptional

Site reference ID (Path 2).

storeNumberstringOptional

Alias for siteReferenceId — same Entity Service param (Path 2).

merchantNamestringOptional

Merchant name (Path 2).

siteNamestringOptional

Site name (Path 2).

estateManagementIdstringOptional

Estate management ID — resolves POI and parent entity directly (Path 3).

Responses
200

POI lookup result.

application/json

Response for POI lookup by merchant identifiers.

merchantNamestringOptional

Merchant name.

siteNamestringOptional

Site name.

siteReferenceIdstringOptional

Site reference ID.

storeNumberstringOptional

Alias for siteReferenceId.

merchantIdstringOptional

Acquirer MID from Payment Provider Contract.

altVfiEntityIdstringOptional

Verifone gateway MID (ISO8583 DE42).

merchantCompanyUidstring · uuidOptional

entityUid of the ancestor MERCHANT_COMPANY entity.

entityUidstring · uuidOptional

entityUid of the resolved site.

get/pois/lookup
GET /pois/lookup HTTP/1.1
Host: api.verifone.com
Accept: */*

{
  "merchantName": "text",
  "siteName": "text",
  "siteReferenceId": "text",
  "storeNumber": "text",
  "merchantId": "text",
  "altVfiEntityId": "text",
  "merchantCompanyUid": "123e4567-e89b-12d3-a456-426614174000",
  "entityUid": "123e4567-e89b-12d3-a456-426614174000",
  "pois": [
    {
      "poiUid": "123e4567-e89b-12d3-a456-426614174000",
      "estateManagementId": "text",
      "poiName": "text"
    }
  ]
}

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
204

Patch POI Success.

patch/pois/{poiUid}
PATCH /pois/{poiUid} HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "ACTIVE"
}
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
204

The Poi was successfully deleted.

delete/pois/{poiUid}
DELETE /pois/{poiUid} HTTP/1.1
Host: api.verifone.com
Accept: */*

No content
PreviousMerchant Maintenance
NextMaintenance Orders

Last updated

Was this helpful?