v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB
Common
POI Maintenance

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.

get/pois/lookup

Query parameters

merchantIdstring

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

altVfiEntityIdstring

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

siteReferenceIdstring

Site reference ID (Path 2).

storeNumberstring

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

merchantNamestring

Merchant name (Path 2).

siteNamestring

Site name (Path 2).

estateManagementIdstring

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

Response

POI lookup result.

merchantNamestring

Merchant name.

siteNamestring

Site name.

siteReferenceIdstring

Site reference ID.

storeNumberstring

Alias for siteReferenceId.

merchantIdstring

Acquirer MID from Payment Provider Contract.

altVfiEntityIdstring

Verifone gateway MID (ISO8583 DE42).

merchantCompanyUidstring uuid

entityUid of the ancestor MERCHANT_COMPANY entity.

entityUidstring uuid

entityUid of the resolved site.