View a Client

Retrieve details about your platform registered with Mangopay

Responses

200

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 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.

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.

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of the address.

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.

Show properties

BusinessType · string

The business type of the platform.

Sector · string

The sector of activity of the platform.

PlatformURL · string

The URL of the platform’s website.

PlatformDescription · string

Max. length: 2,000 characters

The 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 code

The primary color of your branding, which is displayed on some payment pages (e.g., mandate confirmation).

PrimaryButtonColour · string

Hex color code

The primary color of your branding, which is displayed in call-to-action buttons on some payment pages (e.g., mandate confirmation).

Logo · string

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.

200

{
    "PlatformType": null,
    "ClientId": "sandbox4586",
    "Name": "Platform's trading name",
    "RegisteredName": "Platform's legally registered name",
    "TechEmails": [
        "[e-mail]"
    ],
    "AdminEmails": [],
    "BillingEmails": [],
    "FraudEmails": [],
    "HeadquartersAddress": {
        "AddressLine1": "Rue des plantes",
        "AddressLine2": "The Oasis",
        "City": "Paris",
        "Region": "Ile de France",
        "PostalCode": "75010",
        "Country": "FR"
    },
    "HeadquartersPhoneNumber": "[phone]",
    "TaxNumber": "n/a",
    "PlatformCategorization": {
        "BusinessType": "MARKETPLACE",
        "Sector": "RENTALS"
    },
    "PlatformURL": "http://example.com",
    "PlatformDescription": "n/a",
    "CompanyReference": null,
    "PrimaryThemeColour": "#afafaf",
    "PrimaryButtonColour": "#ff974b",
    "Logo": null,
    "CompanyNumber": "00000000000000000000",
    "MCC": "0742"
}  

REST

// GET has no body parameters