Update a Client

PUT

/v2.01/:ClientId/clients

PUT

/v2.01/:ClientId/clients

$ curl -X PUT https://api.sandbox.mangopay.com/v2.01/ClientId/clients \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "PrimaryButtonColour": "#89E481",
>     "PrimaryThemeColour": "#867EFF"
>   }
> }'

200Updated

1 {
2   "PlatformType": null,
3   "ClientId": "example-client-id",
4   "Name": "PlatformTradingName",
5   "RegisteredName": "Platform operator's legally registered name",
6   "TechEmails": [
7     "platform-tech@example.com"
8   ],
9   "AdminEmails": [
10     "platform-payments@example.com"
11   ],
12   "BillingEmails": [
13     "platform-accounting@example.com"
14   ],
15   "FraudEmails": [
16     "platform-disputes@example.com"
17   ],
18   "HeadquartersAddress": {
19     "AddressLine1": "100 rue des Plantes",
20     "AddressLine2": null,
21     "City": "Paris",
22     "Region": "Ile de France",
23     "PostalCode": "12345",
24     "Country": "FR"
25   },
26   "HeadquartersPhoneNumber": "+33123456789",
27   "TaxNumber": "12345678",
28   "PlatformCategorization": {
29     "BusinessType": "MARKETPLACE",
30     "Sector": "RENTALS"
31   },
32   "PlatformURL": "http://example.com",
33   "PlatformDescription": "Example description of your platform's business activity",
34   "CompanyReference": "comp_01HYDEAFS3XY4551TZHWW32RC5",
35   "PrimaryThemeColour": "#867EFF",
36   "PrimaryButtonColour": "#89E481",
37   "Logo": "https://res.cloudinary.com/mangopay-dev/image/upload/v1772722797/mrebvcrkjgxnguvoelgj.png",
38   "CompanyNumber": "00000000000000000000",
39   "MCC": "7519",
40   "Licensor": "EU"
41 }

Modify certain information registered with Mangopay for your platform, notably:

PrimaryThemeColour and PrimaryButtonColour, which you can use to customize the appearance of Mangopay’s hosted SCA - read more →

Modify certain information registered with Mangopay for your platform, notably: - `PrimaryThemeColour` and `PrimaryButtonColour`, which you can use to customize the appearance of Mangopay's hosted SCA - [read more](/guides/sca/factors#customization) **→**

Authentication

AuthorizationBearer

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.

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.

Request

This endpoint expects an object.

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 address of the platform operator's headquarters. This parameter must be provided for the platform's payouts to be processed.

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.

PlatformURLstringOptional

The URL of the platform's website.

PlatformDescriptionstringOptional

Max. length: 2,000 characters

The description of what the platform does.

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.

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.

LogostringOptional

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

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.