v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB
Customer

Get Customer

get/v2/customer/{customerId}

Path parameters

customerIdstring uuid required

Customer UUID

Response

Successful

idstring uuid required

Customer UUID.

company_namestring

Company name of the customer. Required when billing.first_name and billing.last_name 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 email

Consumer's email address.

Note: Required for 3DS. Please refer to the 3D Secure API specification for format requirements.

entity_idstring required

Entity ID on which the customer is created.

phone_numberstring

Cardholder's phone number.

titlestring

Customer's title (e.g. Mr, Mrs, Dr).

work_phonestring

Consumer's work phone number.

languagestring

Customer language preference for Invoice documents. See Localisation for details.

created_atstring date-time required

Timestamp when this customer was created.

updated_atstring date-time required

Timestamp when this customer was last updated.