The User object

A User can be "Natural" or "Legal". With a UserId, you are able to:

  • Fetch a user and get their details
  • List all the wallets of a user
  • Get all your users in a list

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

PersonType
PersonType

PersonType:

NATURAL, LEGAL

Type of user

Email
string

string:

Maximum length is 255 characters

The person's email address (not more than 12 consecutive numbers) - must be a valid email

KYCLevel
KYCLevel

KYCLevel:

LIGHT, REGULAR

The User object will also include further parameters depending on the "PersonType" (see below).

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"PersonType": "NATURAL",
"Email": "support@mangopay.com",
"KYCLevel": "REGULAR"
}

The Natural User object

A Natural User is a person whereas a legal user represents a business or an organisation. This natural user is able to:

  • process payments
  • transfer e-money between wallets
  • withdraw e-money from a wallet
  • create wallets, etc.

Please refer to our KYC Rules in order to find out more about procedures and authentication levels.

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

PersonType
PersonType

PersonType:

NATURAL, LEGAL

Type of user

Email
string

string:

Maximum length is 255 characters

The person's email address (not more than 12 consecutive numbers) - must be a valid email

KYCLevel
KYCLevel

KYCLevel:

LIGHT, REGULAR
FirstName
string

string:

Maximum length is 255 characters

The name of the user

LastName
string

string:

Maximum length is 255 characters

The last name of the user

Address
Address

Address:

View Sub-parameters

The address

Address.AddressLine1
string

string:

Maximum length is 255 characters

The first line of the address

Address.AddressLine2
string

string:

Maximum length is 255 characters

The second line of the address

Address.City
string

string:

Maximum length is 255 characters

The city of the address

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

Address.PostalCode
string

string:

Maximum length is 255 characters

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

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

Birthday
timestamp

timestamp

The date of birth of the user - be careful to set the right timezone (should be UTC) to avoid 00h becoming 23h (and hence interpreted as the day before)

Nationality
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 user’s nationality. ISO 3166-1 alpha-2 format is expected

CountryOfResidence
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 user’s country of residence. ISO 3166-1 alpha-2 format is expected

Occupation
string

string:

Maximum length is 255 characters

User’s occupation, ie. Work

IncomeRange
int

int

Could be only one of these values: 1 - for incomes <18K€),2 - for incomes between 18 and 30K€, 3 - for incomes between 30 and 50K€, 4 - for incomes between 50 and 80K€, 5 - for incomes between 80 and 120K€, 6 - for incomes >120K€

ProofOfAddress
string

string:

Maximum length is 255 characters
ProofOfIdentity
string

string:

Maximum length is 255 characters
Capacity
CapacityType

CapacityType:

NORMAL, DECLARATIVE

The capacity of this user - for use with UBO declarations

The capacity of this user - for use with UBO declarations

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"PersonType": "NATURAL",
"Email": "support@mangopay.com",
"KYCLevel": "REGULAR",
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"Birthday": 1463496101,
"Nationality": "GB",
"CountryOfResidence": "FR",
"Occupation": "Carpenter",
"IncomeRange": 2,
"ProofOfAddress": "752nsyuTAns9",
"ProofOfIdentity": "jsg9h628Nsuha",
"Capacity": "NORMAL"
}

Create a Natural User

Note that the Birthday field is a timestamp, but be careful to ensure that the time is midnight UTC (otherwise a local time can be understood as 23h UTC, and therefore rendering the wrong date which will present problems when needing to validate the KYC identity)

POST .../v2.01/ClientId

The ID of your client account

/users/natural/

Parameters

Tag
string

string:

Maximum length is 255 characters
optional

Custom data that you can add to this item

FirstName
string

string:

Maximum length is 255 characters
required

The name of the user

LastName
string

string:

Maximum length is 255 characters
required

The last name of the user

Address
Address

Address:

View Sub-parameters
optional

The address

Address.AddressLine1
string

string:

Maximum length is 255 characters
required

The first line of the address

Address.AddressLine2
string

string:

Maximum length is 255 characters
optional

The second line of the address

Address.City
string

string:

Maximum length is 255 characters
required

The city of the address

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

Address.PostalCode
string

string:

Maximum length is 255 characters
required

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

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

Birthday
timestamp

timestamp
required

The date of birth of the user - be careful to set the right timezone (should be UTC) to avoid 00h becoming 23h (and hence interpreted as the day before)

Nationality
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 user’s nationality. ISO 3166-1 alpha-2 format is expected

CountryOfResidence
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 user’s country of residence. ISO 3166-1 alpha-2 format is expected

Occupation
string

string:

Maximum length is 255 characters
optional

User’s occupation, ie. Work

IncomeRange
int

int
optional

Could be only one of these values: 1 - for incomes <18K€),2 - for incomes between 18 and 30K€, 3 - for incomes between 30 and 50K€, 4 - for incomes between 50 and 80K€, 5 - for incomes between 80 and 120K€, 6 - for incomes >120K€

Email
string

string:

Maximum length is 255 characters
required

The person's email address (not more than 12 consecutive numbers) - must be a valid email

Capacity
CapacityType

CapacityType:

NORMAL, DECLARATIVE

The capacity of this user - for use with UBO declarations
optional

The capacity of this user - for use with UBO declarations

  • View
  • Code
  • Run
  • View
  • Code
  • Run
POST .../users/natural/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"Birthday": 1463496101,
"Nationality": "GB",
"CountryOfResidence": "FR",
"Occupation": "Carpenter",
"IncomeRange": 2,
"Email": "support@mangopay.com",
"Capacity": "NORMAL"
}
require_once("mangopay.php");

try {


$UserNatural = new \MangoPay\UserNatural();
$UserNatural->Tag = "custom meta";
$UserNatural->FirstName = "Joe";
$UserNatural->LastName = "Blogs";
$UserNatural->Address = new \MangoPay\Address();
$UserNatural->Address->AddressLine1 = "1 Mangopay Street";
$UserNatural->Address->AddressLine2 = "The Loop";
$UserNatural->Address->City = "Paris";
$UserNatural->Address->Region = "Ile de France";
$UserNatural->Address->PostalCode = "75001";
$UserNatural->Address->Country = "FR";
$UserNatural->Birthday = 1463496101;
$UserNatural->Nationality = "GB";
$UserNatural->CountryOfResidence = "FR";
$UserNatural->Occupation = "Carpenter";
$UserNatural->IncomeRange = 2;
$UserNatural->Email = "support@mangopay.com";
$UserNatural->Capacity = "NORMAL";

$Result = $Api->Users->Create($UserNatural);

} 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()

}
POST .../users/natural/ HTTP/1.1
Body Parameters :
{
"Tag": "",
"FirstName": "",
"LastName": "",
"Address": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"Birthday": ,
"Nationality": "",
"CountryOfResidence": "",
"Occupation": "",
"IncomeRange": ,
"Email": "",
"Capacity": ""
}

Update a Natural User

PUT .../v2.01/ClientId

The ID of your client account

/users/natural/UserId

A Mangopay user's ID

/

Parameters

Tag
string

string:

Maximum length is 255 characters
optional

Custom data that you can add to this item

FirstName
string

string:

Maximum length is 255 characters
optional

The name of the user

LastName
string

string:

Maximum length is 255 characters
optional

The last name of the user

Address
Address

Address:

View Sub-parameters
optional

The address

Address.AddressLine1
string

string:

Maximum length is 255 characters
required

The first line of the address

Address.AddressLine2
string

string:

Maximum length is 255 characters
optional

The second line of the address

Address.City
string

string:

Maximum length is 255 characters
required

The city of the address

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

Address.PostalCode
string

string:

Maximum length is 255 characters
required

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

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

Birthday
timestamp

timestamp
optional

The date of birth of the user - be careful to set the right timezone (should be UTC) to avoid 00h becoming 23h (and hence interpreted as the day before)

Nationality
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
optional

The user’s nationality. ISO 3166-1 alpha-2 format is expected

CountryOfResidence
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
optional

The user’s country of residence. ISO 3166-1 alpha-2 format is expected

Occupation
string

string:

Maximum length is 255 characters
optional

User’s occupation, ie. Work

IncomeRange
int

int
optional

Could be only one of these values: 1 - for incomes <18K€),2 - for incomes between 18 and 30K€, 3 - for incomes between 30 and 50K€, 4 - for incomes between 50 and 80K€, 5 - for incomes between 80 and 120K€, 6 - for incomes >120K€

Email
string

string:

Maximum length is 255 characters
optional

The person's email address (not more than 12 consecutive numbers) - must be a valid email

  • View
  • Code
  • Run
  • View
  • Code
  • Run
PUT .../users/natural/:UserId/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"FirstName": "Joe",
"LastName": "Blogs",
"Address": {
"AddressLine1": "1 Mangopay Street",
"AddressLine2": "The Loop",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
},
"Birthday": 1463496101,
"Nationality": "GB",
"CountryOfResidence": "FR",
"Occupation": "Carpenter",
"IncomeRange": 2,
"Email": "support@mangopay.com"
}
require_once("mangopay.php");

try {

$UserNatural = new \MangoPay\UserNatural();
$UserNatural->Tag = "custom meta";
$UserNatural->FirstName = "Joe";
$UserNatural->LastName = "Blogs";
$UserNatural->Address = new \MangoPay\Address();
$UserNatural->Address->AddressLine1 = "1 Mangopay Street";
$UserNatural->Address->AddressLine2 = "The Loop";
$UserNatural->Address->City = "Paris";
$UserNatural->Address->Region = "Ile de France";
$UserNatural->Address->PostalCode = "75001";
$UserNatural->Address->Country = "FR";
$UserNatural->Birthday = 1463496101;
$UserNatural->Nationality = "GB";
$UserNatural->CountryOfResidence = "FR";
$UserNatural->Occupation = "Carpenter";
$UserNatural->IncomeRange = 2;
$UserNatural->Email = "support@mangopay.com";
$UserNatural->Id = 8494514;

$Result = $Api->Users->Update($UserNatural);

} 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 .../users/natural// HTTP/1.1
Body Parameters :
{
"Tag": "",
"FirstName": "",
"LastName": "",
"Address": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
"Birthday": ,
"Nationality": "",
"CountryOfResidence": "",
"Occupation": "",
"IncomeRange": ,
"Email": ""
}

View a User

GET .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

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

try {

$UserId = 8494514;

$User = $Api->Users->Get($UserId);

} 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 .../users// HTTP/1.1

List all Users

GET .../v2.01/ClientId

The ID of your client account

/users/

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

The column to sort against and direction, separated by a :
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

BeforeDate
timestamp

timestamp
optional

To return only resources that have CreationDate BEFORE this date

AfterDate
timestamp

timestamp
optional

To return only resources that have CreationDate AFTER this date

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../users/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC",
"BeforeDate": 1463440221,
"AfterDate": 1431817821
}
GET .../users/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": "",
"BeforeDate": ,
"AfterDate":
}
Live-chat
No agent is free at the moment please send us a request through our contact form
CONTACT FORM