Skip to main content

​
Description

The Client object represents your platform. There is one client object per ClientId.

​
Attributes

​
string
The unique identifier associated with the API key, giving access to either the Sandbox or Production environment.
​
string
The trading name of the company operating the platform.
​
string
The registered legal name of the company operating the platform.
​
array
Format: Emails must be ≤ 40 charactersList 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.
​
array
List of email addresses to contact the platform for administrative or commercial matters.
​
array
List of email addresses to contact the platform for billing matters.
​
array
List of email addresses to contact the platform for fraud and compliance matters.
​
object
The address of the platform operator’s headquarters. This parameter must be provided for the platform’s payouts to be processed.
​
string
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.
​
string
The tax (or VAT) number for the company operating the platform.
​
object
The categorization of the platform in terms of business and sector of activity.
​
string
The URL of the platform’s website.
​
string
Max. length: 2,000 charactersThe description of what the platform does.
​
string
The unique reference for the platform, which should be used when contacting Mangopay.
​
string
Hex color codeThe color used in accent highlights and icon elements on Mangopay-hosted webpages, such as in SCA customization.
​
string
Hex color codeThe 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.
​
string
The registration number of the company operating the platform, assigned by the relevant national authority.
​
string
4-digit merchant category code. The MCC is used to classify a business by the types of goods or services it provides.