The Client object
The Client details object allows you to view and edit various details about your platform.
- At this time, only a limited number of parameters are editable via the PUT method – this will be updated in the future.
Parameters
Namestring:
Maximum length is 255 characters
The pretty name for the client
RegisteredNamestring:
Maximum length is 255 characters
The registered name of your company
ClientIdstring:
Maximum length is 255 characters
An ID for the client (i.e. url friendly, lowercase etc - sort of namespace identifier)
PrimaryThemeColourHEXColor:
A hexidecimal CSS color
The primary branding colour to use for your merchant
PrimaryButtonColourHEXColor:
A hexidecimal CSS color
The primary branding colour to use for buttons for your merchant
Logostring:
Maximum length is 255 characters
The URL of the logo of your client
TechEmailslist
A list of email addresses to use when contacting you for technical issues/communications. Emails must be ≤ 40 characters.
AdminEmailslist
A list of email addresses to use when contacting you for admin/commercial issues/communications
FraudEmailslist
A list of email addresses to use when contacting you for fraud/compliance issues/communications
BillingEmailslist
A list of email addresses to use when contacting you for billing issues/communications
PlatformCategorizationPlatformCategorization:
Platform information (Business Type and Sector)
View Sub-parameters
The Categorization of your platform, in terms of Business Type and Sector
PlatformCategorization.BusinessTypeBusinessType:
MARKETPLACE, CROWDFUNDING, FRANCHISE, OTHER
Business Type of your Platform
PlatformCategorization.SectorSector:
RENTALS, STORES_FASHION_ACCESSORIES_OBJECTS, BEAUTY_COSMETICS_HEALTH, FOOD_WINE_RESTAURANTS, HOSPITALITY_TRAVEL_CORIDING, ART_MUSIC_ENTERTAINMENT, FURNITURE_GARDEN, SERVICES_JOBBING_EDUCATION, SPORT_RECREATION_ACTIVITIES, TICKETING, LOAN, EQUITY, PROPERTY_EQUITY, REWARDS_CHARITY, POOL_GROUP_PAYMENT, FRANCHISE_, OTHER_
The sector of your platform activity
PlatformDescriptionstring:
Maximum length is 2000 characters
A description of what your platform does
PlatformURLstring:
Maximum length is 255 characters
The URL for your website
HeadquartersAddressAddress:
View Sub-parameters
The address of the company’s headquarters. This field is mandatory to accept payout (More info here).
HeadquartersAddress.AddressLine1string:
Maximum length is 255 characters
The first line of the address
HeadquartersAddress.AddressLine2string:
Maximum length is 255 characters
The second line of the address
HeadquartersAddress.Citystring:
Maximum length is 255 characters
The city of the address
HeadquartersAddress.Regionstring:
Maximum length is 255 characters
The region of the address - this is optional except if the Country is US, CA or MX
HeadquartersAddress.PostalCodestring:
Maximum length is 50 characters
The postal code of the address - can be alphanumeric, dashes or spaces
HeadquartersAddress.CountryCountryIso:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
A valid ISO 3166-1 alpha-2 format
The Country of the Address
TaxNumberstring:
Maximum length is 255 characters
The tax (or VAT) number for your company
CompanyReferencestring:
Maximum length is 255 characters
Your unique MANGOPAY reference which you should use when contacting us