v2

latestOpenAPI 3.1.02026-07-262279731.3 MB

Client

View a Client

Retrieve details about your platform registered with Mangopay

get/v2.01/{ClientId}/clients

Path parameters

ClientIdstring required

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

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Response

Success

PlatformTypestring

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

ClientIdstring

The unique identifier associated with the API key, giving access to either the Sandbox or Production environment.

Namestring

The trading name of the company operating the platform.

RegisteredNamestring

The registered legal name of the company operating the platform.

TechEmailsstring[]

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.

AdminEmailsstring[]

List of email addresses to contact the platform for administrative or commercial matters.

BillingEmailsstring[]

List of email addresses to contact the platform for billing matters.

FraudEmailsstring[]

List of email addresses to contact the platform for fraud and compliance matters.

HeadquartersPhoneNumberstring

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.

TaxNumberstring

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

PlatformURLstring

The URL of the platform’s website.

PlatformDescriptionstring

Max. length: 2,000 characters

The description of what the platform does.

CompanyReferencestring

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

PrimaryThemeColourstring

Hex color code

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

PrimaryButtonColourstring

Hex color code

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

Logostring

The URL of the platform’s logo. Logos may be added by using the Upload a Client Logo endpoint.

CompanyNumberstring

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

MCCstring

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

Licensorstring

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.