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

Name
string

string:

Maximum length is 255 characters

The pretty name for the client

ClientId
string

string:

Maximum length is 255 characters

An ID for the client (i.e. url friendly, lowercase etc - sort of namespace identifier)

PrimaryThemeColour
HEXColor

HEXColor:

A hexidecimal CSS color

The primary branding colour to use for your merchant

PrimaryButtonColour
HEXColor

HEXColor:

A hexidecimal CSS color

The primary branding colour to use for buttons for your merchant

Logo
string

string:

Maximum length is 255 characters

The URL of the logo of your client

TechEmails
list

list

A list of email addresses to use when contacting you for technical issues/communications

AdminEmails
list

list

A list of email addresses to use when contacting you for admin/commercial issues/communications

FraudEmails
list

list

A list of email addresses to use when contacting you for fraud/compliance issues/communications

BillingEmails
list

list

A list of email addresses to use when contacting you for billing issues/communications

PlatformDescription
string

string:

Maximum length is 255 characters

A description of what your platform does

PlatformType
PlatformType

PlatformType:

MARKETPLACE, P2P_PAYMENT, CROWDFUNDING_DONATION, CROWDFUNDING_REWARD, CROWDFUNDING_EQUITY, CROWDFUNDING_LOAN, OTHER

The type of platform

PlatformURL
string

string:

Maximum length is 255 characters

The URL for your website

HeadquartersAddress
Address

Address:

View Sub-parameters

The address of the company’s headquarters

HeadquartersAddress.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

HeadquartersAddress.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

HeadquartersAddress.City
string

string:

Maximum length is 255 characters

The city of the address

HeadquartersAddress.Region
string

string:

Maximum length is 255 characters

The region of the address - this is optional except if the Country is US, CA or MX

HeadquartersAddress.PostalCode
string

string:

Maximum length is 255 characters

The postal code of the address - can be alphanumeric, dashes or spaces

HeadquartersAddress.Country
CountryIso

CountryIso:

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

TaxNumber
string

string:

Maximum length is 255 characters

The tax (or VAT) number for your company

Update a Client

PUT .../v2.01/ClientId

The ID of your client account

/clients/

Parameters

PrimaryButtonColour
HEXColor

HEXColor:

A hexidecimal CSS color

optional

The primary branding colour to use for buttons for your merchant

PrimaryThemeColour
HEXColor

HEXColor:

A hexidecimal CSS color

optional

The primary branding colour to use for your merchant

AdminEmails
list

list

optional

A list of email addresses to use when contacting you for admin/commercial issues/communications

TechEmails
list

list

optional

A list of email addresses to use when contacting you for technical issues/communications

BillingEmails
list

list

optional

A list of email addresses to use when contacting you for billing issues/communications

FraudEmails
list

list

optional

A list of email addresses to use when contacting you for fraud/compliance issues/communications

HeadquartersAddress
Address

Address:

View Sub-parameters

optional

The address of the company’s headquarters

HeadquartersAddress.AddressLine1
string

string:

Maximum length is 255 characters

required

The first line of the address

HeadquartersAddress.AddressLine2
string

string:

Maximum length is 255 characters

optional

The second line of the address

HeadquartersAddress.City
string

string:

Maximum length is 255 characters

required

The city of the address

HeadquartersAddress.Region
string

string:

Maximum length is 255 characters

required

The region of the address - this is optional except if the Country is US, CA or MX

HeadquartersAddress.PostalCode
string

string:

Maximum length is 255 characters

required

The postal code of the address - can be alphanumeric, dashes or spaces

HeadquartersAddress.Country
CountryIso

CountryIso:

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

required

The Country of the Address

TaxNumber
string

string:

Maximum length is 255 characters

optional

The tax (or VAT) number for your company

PlatformType
PlatformType

PlatformType:

MARKETPLACE, P2P_PAYMENT, CROWDFUNDING_DONATION, CROWDFUNDING_REWARD, CROWDFUNDING_EQUITY, CROWDFUNDING_LOAN, OTHER

optional

The type of platform

PlatformDescription
string

string:

Maximum length is 255 characters

optional

A description of what your platform does

PlatformURL
string

string:

Maximum length is 255 characters

optional

The URL for your website

  • View
  • Code
  • Run
  • View
  • Code
  • Run
PUT .../clients/ HTTP/1.1
Body Parameters :
{
"PrimaryButtonColour": "#508c4a",
"PrimaryThemeColour": "#d0ae5f",
"AdminEmails": [ "support@mangopay.com" ],
"TechEmails": [ "support@mangopay.com" ],
"BillingEmails": [ "support@mangopay.com" ],
"FraudEmails": [ "support@mangopay.com" ],
"HeadquartersAddress": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"TaxNumber": "FR52BSSS",
"PlatformType": "MARKETPLACE",
"PlatformDescription": "We are a marketplace specialised in rare flipflops for Europe and America. ",
"PlatformURL": "https://www.mangopay.com"
}
require_once("mangopay.php");

try {

$Client = new \MangoPay\Client();
$Client->PrimaryButtonColour = "#508c4a";
$Client->PrimaryThemeColour = "#d0ae5f";
$Client->AdminEmails = array ("support@mangopay.com");
$Client->TechEmails = array ("support@mangopay.com");
$Client->BillingEmails = array ("support@mangopay.com");
$Client->FraudEmails = array ("support@mangopay.com");
$Client->HeadquartersAddress = new \MangoPay\Address();
$Client->HeadquartersAddress->AddressLine1 = "1 Mangopay Street";
$Client->HeadquartersAddress->AddressLine2 = "The Loop";
$Client->HeadquartersAddress->City = "Paris";
$Client->HeadquartersAddress->Region = "Ile de France";
$Client->HeadquartersAddress->PostalCode = "75001";
$Client->HeadquartersAddress->Country = "FR";
$Client->TaxNumber = "FR52BSSS";
$Client->PlatformType = "MARKETPLACE";
$Client->PlatformDescription = "We are a marketplace specialised in rare flipflops for Europe and America. ";
$Client->PlatformURL = "https://www.mangopay.com";

$Result = $Api->Clients->Update($Client);

} catch(MangoPay\Libraries\ResponseException $e) {
// handle/log the response exception with code $e->GetCode(), message $e->GetMessage() and error(s) $e->GetErrorDetails()

} catch(MangoPay\Libraries\Exception $e) {
// handle/log the exception $e->GetMessage()

}
PUT .../clients/ HTTP/1.1
Body Parameters :
{
"PrimaryButtonColour": "",
"PrimaryThemeColour": "",
"AdminEmails": [ "" ],
"TechEmails": [ "" ],
"BillingEmails": [ "" ],
"FraudEmails": [ "" ],
"HeadquartersAddress": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"TaxNumber": "",
"PlatformType": "",
"PlatformDescription": "",
"PlatformURL": ""
}

View a Client

GET .../v2.01/ClientId

The ID of your client account

/clients/
  • View
  • Code
  • Run
  • View
  • Code
  • Run
GET .../clients/ HTTP/1.1
require_once("mangopay.php");

try {


$Client = $Api->Clients->Get();

} catch(MangoPay\Libraries\ResponseException $e) {
// handle/log the response exception with code $e->GetCode(), message $e->GetMessage() and error(s) $e->GetErrorDetails()

} catch(MangoPay\Libraries\Exception $e) {
// handle/log the exception $e->GetMessage()

}
GET .../clients/ HTTP/1.1