Skip to main content
GET
/
v2.01
/
{ClientId}
/
clients
// GET has no body parameters

{
    "PlatformType": null,
    "ClientId": "example-client-id",
    "Name": "PlatformTradingName",
    "RegisteredName": "Platform operator's legally registered name",
    "TechEmails": [
        "platform-tech@example.com"
    ],
    "AdminEmails": [
        "platform-payments@example.com"
    ],
    "BillingEmails": [
        "platform-accounting@example.com"
    ],
    "FraudEmails": [
        "platform-disputes@example.com"
    ],
    "HeadquartersAddress": {
        "AddressLine1": "100 rue des Plantes",
        "AddressLine2": null,
        "City": "Paris",
        "Region": "Ile de France",
        "PostalCode": "12345",
        "Country": "FR"
    },
    "HeadquartersPhoneNumber": "+33123456789",
    "TaxNumber": "12345678",
    "PlatformCategorization": {
        "BusinessType": "MARKETPLACE",
        "Sector": "RENTALS"
    },
    "PlatformURL": "http://example.com",
    "PlatformDescription": "Example description of your platform's business activity",
    "CompanyReference": "comp_01HYDEAFS3XY4551TZHWW32RC5",
    "PrimaryThemeColour": "#867EFF",
    "PrimaryButtonColour": "#89E481",
    "Logo": "https://res.cloudinary.com/mangopay-dev/image/upload/v1772722797/mrebvcrkjgxnguvoelgj.png",
    "CompanyNumber": "00000000000000000000",
    "MCC": "7519",
    "Licensor": "EU"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Responses

200 - Response parameters

​
PlatformType
string
Type of the platform. This field has been replaced by the PlatformCategorization object.
​
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 color used in accent highlights and icon elements on Mangopay-hosted webpages, such as in SCA customization.
​
PrimaryButtonColour
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.
​
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.
​
Licensor
string
Possible values: EU, UKThe licensor of the platform’s company account, indicating the Mangopay entity the platform contracted with:
  • EU – Mangopay S.A.
  • UK – Mangopay U.K. Ltd.
{
    "PlatformType": null,
    "ClientId": "example-client-id",
    "Name": "PlatformTradingName",
    "RegisteredName": "Platform operator's legally registered name",
    "TechEmails": [
        "platform-tech@example.com"
    ],
    "AdminEmails": [
        "platform-payments@example.com"
    ],
    "BillingEmails": [
        "platform-accounting@example.com"
    ],
    "FraudEmails": [
        "platform-disputes@example.com"
    ],
    "HeadquartersAddress": {
        "AddressLine1": "100 rue des Plantes",
        "AddressLine2": null,
        "City": "Paris",
        "Region": "Ile de France",
        "PostalCode": "12345",
        "Country": "FR"
    },
    "HeadquartersPhoneNumber": "+33123456789",
    "TaxNumber": "12345678",
    "PlatformCategorization": {
        "BusinessType": "MARKETPLACE",
        "Sector": "RENTALS"
    },
    "PlatformURL": "http://example.com",
    "PlatformDescription": "Example description of your platform's business activity",
    "CompanyReference": "comp_01HYDEAFS3XY4551TZHWW32RC5",
    "PrimaryThemeColour": "#867EFF",
    "PrimaryButtonColour": "#89E481",
    "Logo": "https://res.cloudinary.com/mangopay-dev/image/upload/v1772722797/mrebvcrkjgxnguvoelgj.png",
    "CompanyNumber": "00000000000000000000",
    "MCC": "7519",
    "Licensor": "EU"
}  

// GET has no body parameters