v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB
Internal

Get the list of all Verifone Sites in Billing Engine

Using the UUID of the user or the merchantCompanyUid in the query (ROLE) Dependent.

get/accounts/sites

Query parameters

customerEntityUidstring uuid required

The Verifone allocated unique id for this site.

The estate customer entity UUID for the portfolio.

merchantCompanyEntityUidstring uuid

The Verifone allocated unique ID for this merchant company.

The Verifone assigned ID corresponding to the Merchant Company.

billingSitesOnlyboolean

Only return the billing sites.

billingSiteIdstring

The billing site id to query.

locateCustomerboolean

A flag to indicate if when creating the user to verify them by locating the customer in the Verifone billing systems.

merchantCompanystring

The primary merchant name, e.g. "McDonalds".

The merchant company.

addressLinestring

Address Line. Should include street and apartment number if required.

The first line of the address.

postCodestring

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

The postal code of the address.

activeBankstring

Last 4 digits of active bank account

Last 4 digits of active bank account.

customerIdstring

Customer ID in Oracle

Customer ID of existing unapproved user.

siteIdstring

Site ID of existing unapproved user.

Site ID of existing unapproved user.

Response

Search results matching criteria.