Description

The Client object allows you to view and edit information regarding your platform account.

Attributes

ClientId
string
The unique identifier associated with the API key, giving access to either the Sandbox or Production environment.
Name
string
The trading name of the company operating the platform.
RegisteredName
string
The registered legal name of the company operating the platform.
TechEmails
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.
AdminEmails
array
List of email addresses to contact the platform for administrative or commercial matters.
BillingEmails
array
List of email addresses to contact the platform for billing matters.
FraudEmails
array
List of email addresses to contact the platform for fraud and compliance matters.
HeadquartersAddress
object
The address of the platform operator’s headquarters. This parameter must be provided for the platform’s payouts to be processed.
HeadquartersPhoneNumber
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.
TaxNumber
string
The tax (or VAT) number for the company operating the platform.
PlatformCategorization
object
The categorization of the platform in terms of business and sector of activity.
PlatformURL
string
The URL of the platform’s website.
PlatformDescription
string
Max. length: 2,000 charactersThe description of what the platform does.
CompanyReference
string
The unique reference for the platform, which should be used when contacting Mangopay.
PrimaryThemeColour
string
Hex color codeThe primary color of your branding, which is displayed on some payment pages (e.g., mandate confirmation).
PrimaryButtonColour
string
Hex color codeThe primary color of your branding, which is displayed in call-to-action buttons on some payment pages (e.g., mandate confirmation).
The URL of the platform’s logo. Logos may be added by using the Upload a Client Logo endpoint.
CompanyNumber
string
The registration number of the company operating the platform, assigned by the relevant national authority.
MCC
string
4-digit merchant category code. The MCC is used to classify a business by the types of goods or services it provides.