Platform accountClient

View a Client

Retrieve details about your platform registered with Mangopay

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.

Response

Success
PlatformTypestringOptional

Type of the platform. This field has been replaced by the PlatformCategorization object.

ClientIdstringOptional
The unique identifier associated with the API key, giving access to either the Sandbox or Production environment.
NamestringOptional
The trading name of the company operating the platform.
RegisteredNamestringOptional
The registered legal name of the company operating the platform.
TechEmailslist of stringsOptional

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.

AdminEmailslist of stringsOptional
List of email addresses to contact the platform for administrative or commercial matters.
BillingEmailslist of stringsOptional
List of email addresses to contact the platform for billing matters.
FraudEmailslist of stringsOptional
List of email addresses to contact the platform for fraud and compliance matters.
HeadquartersAddressobjectOptional
The postal address.
HeadquartersPhoneNumberstringOptional

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.

TaxNumberstringOptional

The tax (or VAT) number for the company operating the platform.

PlatformCategorizationobjectOptional
The categorization of the platform in terms of business and sector of activity.
PlatformURLstringOptional
The URL of the platform's website.
PlatformDescriptionstringOptional

Max. length: 2,000 characters

The description of what the platform does.

CompanyReferencestringOptional
The unique reference for the platform, which should be used when contacting Mangopay.
PrimaryThemeColourstringOptional

Hex color code

The color used in accent highlights and icon elements on Mangopay-hosted webpages, such as in SCA customization.

PrimaryButtonColourstringOptional

Hex color code

The color used for call-to-action (CTA) buttons on Mangopay-hosted webpages, such as in SCA customization.

CompanyNumberstringOptional
The registration number of the company operating the platform, assigned by the relevant national authority.
MCCstringOptional

4-digit merchant category code. The MCC is used to classify a business by the types of goods or services it provides.

LicensorstringOptional

Possible values: EU, UK

The licensor of the platform’s company account, indicating the Mangopay entity the platform contracted with:

  • EU – Mangopay S.A.
  • UK – Mangopay U.K. Ltd.