Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
View a Client
{
"PlatformType": null,
"ClientId": "sandbox4586",
"Name": "Platform’s name",
"RegisteredName": "Platform’s SA",
"TechEmails": [
"platformtech@example.com"
],
"AdminEmails": [],
"BillingEmails": [],
"FraudEmails": [],
"HeadquartersAddress": {
"AddressLine1": "Rue des plantes",
"AddressLine2": "The Oasis",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75010",
"Country": "FR"
},
"HeadquartersPhoneNumber": "+330606060606",
"TaxNumber": "n/a",
"PlatformCategorization": {
"BusinessType": "MARKETPLACE",
"Sector": "RENTALS"
},
"PlatformURL": "http://mangopay.com/docs/please-ignore",
"PlatformDescription": "n/a",
"CompanyReference": null,
"PrimaryThemeColour": "#afafaf",
"PrimaryButtonColour": "#ff974b",
"Logo": null,
"CompanyNumber": "00000000000000000000",
"MCC": "0742"
}
Responses
Type of the platform. This field has been replaced by the PlatformCategorization object.
The unique identifier associated with the API key, giving access to either the Sandbox or Production environment.
The trading name of the company operating the platform.
The registered legal name of the company operating the platform.
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.
List of email addresses to contact the platform for administrative or commercial matters.
List of email addresses to contact the platform for billing matters.
List of email addresses to contact the platform for fraud and compliance matters.
The address of the platform operator’s headquarters. This parameter must be provided for the platform’s payouts to be processed.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
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.
The tax (or VAT) number for the company operating the platform.
The URL of the platform’s website.
Max. length: 2,000 characters
The description of what the platform does.
The unique reference for the platform, which should be used when contacting Mangopay.
Hex color code
The primary color of your branding, which is displayed on some payment pages (e.g., mandate confirmation).
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).
The URL of the platform’s logo. Logos may be added by using the Upload a Client Logo endpoint.
The registration number of the company operating the platform, assigned by the relevant national authority.
4-digit merchant category code. The MCC is used to classify a business by the types of goods or services it provides.
{
"PlatformType": null,
"ClientId": "sandbox4586",
"Name": "Platform’s name",
"RegisteredName": "Platform’s SA",
"TechEmails": [
"platformtech@example.com"
],
"AdminEmails": [],
"BillingEmails": [],
"FraudEmails": [],
"HeadquartersAddress": {
"AddressLine1": "Rue des plantes",
"AddressLine2": "The Oasis",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75010",
"Country": "FR"
},
"HeadquartersPhoneNumber": "+330606060606",
"TaxNumber": "n/a",
"PlatformCategorization": {
"BusinessType": "MARKETPLACE",
"Sector": "RENTALS"
},
"PlatformURL": "http://mangopay.com/docs/please-ignore",
"PlatformDescription": "n/a",
"CompanyReference": null,
"PrimaryThemeColour": "#afafaf",
"PrimaryButtonColour": "#ff974b",
"Logo": null,
"CompanyNumber": "00000000000000000000",
"MCC": "0742"
}
Was this page helpful?
{
"PlatformType": null,
"ClientId": "sandbox4586",
"Name": "Platform’s name",
"RegisteredName": "Platform’s SA",
"TechEmails": [
"platformtech@example.com"
],
"AdminEmails": [],
"BillingEmails": [],
"FraudEmails": [],
"HeadquartersAddress": {
"AddressLine1": "Rue des plantes",
"AddressLine2": "The Oasis",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75010",
"Country": "FR"
},
"HeadquartersPhoneNumber": "+330606060606",
"TaxNumber": "n/a",
"PlatformCategorization": {
"BusinessType": "MARKETPLACE",
"Sector": "RENTALS"
},
"PlatformURL": "http://mangopay.com/docs/please-ignore",
"PlatformDescription": "n/a",
"CompanyReference": null,
"PrimaryThemeColour": "#afafaf",
"PrimaryButtonColour": "#ff974b",
"Logo": null,
"CompanyNumber": "00000000000000000000",
"MCC": "0742"
}