v1

latestOpenAPI 3.0.1Apache 2.02026-07-2647148658.0 KB
Customer

List Customers

get/v2/customer

Query parameters

searchstring required

RSQL is a REST query language that allows you to filter resources based on their attributes. The RSQL query is a string that represents a query in a human-readable format. The RSQL query is passed as a query parameter in the URL and is used to filter the resources based on the attributes of the resource. See RSQL queries for Checkout API for example filters to use with the Checkout API. See ![RSQL](RSQl https://aboullaite.me/rsql/) for more information on RSQL queries.

order_criteriastring

The ordering sequence of the selected customers If not selected then a default order is based on Created Date Time.', 'The value of orderCriteria can be one of the following: <ul><li>billing.address_1</li><li>billing.address_2</li><li>billing.address_3</li><li>billing.city</li><li>billing.country_code</li><li>billing.first_name</li><li>billing.middle_name</li><li>billing.last_name</li><li>billing.phone</li><li>billing.postal_code</li><li>billing.state</li><li>company_name</li><li>company_registration_number</li><li>email_address</li><li>entity_id</li><li>id</li><li>phone_number</li><li>shipping.address_1</li><li>shipping.address_2</li><li>shipping.address_3</li><li>shipping.city</li><li>shipping.country_code</li><li>shipping.first_name</li><li>shipping.last_name</li><li>shipping.phone</li><li>shipping.postal_code</li><li>shipping.state</li><li>title</li><li>work_phone</li><li>tax.identifier</li><li>created_at</li></ul>

order_by'ASC' | 'DESC'

The ordering sequence of the selected customers If not selected then Descending order is the default order.

page_numbernumber

A filter query in RSQL format to retrieve customers based on page number. If not selected then a default pageNumber is 1.

page_sizenumber

A filter query in RSQL format to retrieve customers based on page size. If not selected then a default pageSize is 50

Response

Successful

idstring required

Customers ID

company_namestring

Company of the customer. . Required in case that billing.firstName & billing.lastName are not provided.

company_registration_numberstring

Unique identifier of the company, recognised by the government. Known as CoC (Chamber of Commerce) number in some countries

email_addressstring

Consumer's email address. <br /> Note:Required for 3DS. Please refer to the 3D Secure API specification for the format requirements.

entity_idstring required

Entity id on which the customer is created. Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)

phone_numberstring

Cardholder's phone number

titlestring

Title

work_phonestring

Consumer's work phone number.

languagestring

Customer language preferences for the Invoice document. Read <a target="_blank" href="https://verifone.cloud/docs/online-payments/localisation">Localisation</a> for details.

created_atstring date required

Time at which this customer has been created

updated_atstring date required

Time at which this customer has been updated for last time