The Client object
Description
The Client object represents your platform. There is one client object per ClientId.
Attributes
The unique identifier of the client.
The trading name of the company operating the platform.
The registered legal name of the company operating the platform.
Format: Emails must be ≤ 40 characters
List of email addresses to contact the platform for technical matters.
Important: If the email length exceeds 40 characters, it will be be impossible to process some payments.
List of email addresses to contact the platform for administrative or commercial matters.
List of email addresses to contact the platform for billing matters.
List of email addresses to contact the platform for fraud and compliance matters.
Required if UserCategory is OWNER. Child parameters returned null if UserCategory is PAYER.
The legally registered address of the entity’s administrative center.
properties
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters The city of the address.
Max. length: 255 characters
Required if Country is US, CA, or MX.
The region of the address.
Max. length: 255 characters The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
The country of the address.
Max. length: 15 characters; international telephone numbering plan E.164 (+ followed by the country code, then the number)
The phone number of the platform operator’s headquarters.
The tax (or VAT) number for the company operating the platform.
The categorization of the platform in terms of business and sector of activity.
properties
The business type of the platform.
The sector of activity of the platform.
The URL of the platform’s website.
Max. length: 2,000 characters
The description of what the platform does.
The unique reference for the platform, which should be used when contacting Mangopay.
Hex color code
The color used in accent highlights and icon elements on Mangopay-hosted webpages, such as in SCA customization.
Hex color code
The color used for call-to-action (CTA) buttons on Mangopay-hosted webpages, such as in SCA customization.
The URL of the platform’s logo. Logos may be added by using the Upload a Client Logo endpoint.
Information about the registration number of a legal entity. For details, see the Company number article.
properties
The registration number of a legal entity, assigned by the relevant national authority.
Note: Any non-alphanumeric characters, like dashes or spaces, are removed before applying the validation rules.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the registration of the legal entity, against which the company number format is validated.
4-digit merchant category code. The MCC is used to classify a business by the types of goods or services it provides.