Multi Merchant

The Multi Merchant endpoints let you manage parent and child POI relationships in a multi-merchant hierarchy.

API Reference

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

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

429

Too Many Requests

application/json

500

Internal Error

application/json

503

Service Not Available

application/json

504

Service Timeout

application/json

get/pois/{poiUid}/parentPoi

HTTPcURLJavaScriptPython

GET /pois/{poiUid}/parentPoi HTTP/1.1
Host: api.verifone.com
Accept: */*

{
  "estateManagementId": "100112345678",
  "status": "ACTIVE",
  "poiUid": "d80fcd67-01ad-47e3-93be-fb073d276c52"
}

Move Child POIs to a New Parent

This operation moves the selected child POIs to a new parent POI. Verify the target poiUid before you run it.

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

application/json

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

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

429

Too Many Requests

application/json

500

Internal Error

application/json

503

Service Not Available

application/json

504

Service Timeout

application/json

post/pois/{poiUid}/childPois/move

HTTPcURLJavaScriptPython

POST /pois/{poiUid}/childPois/move HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "newParentPoiUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1"
}

{
  "estateManagementId": "100112345678",
  "status": "ACTIVE",
  "poiUid": "d80fcd67-01ad-47e3-93be-fb073d276c52"
}