Skip to content

Latest commit

 

History

History
93 lines (88 loc) · 3.49 KB

UserEnrollRequest.md

File metadata and controls

93 lines (88 loc) · 3.49 KB

UserEnrollRequest

Properties

Name Type Max Length Description Notes
companyId String 11 Mastercard assigned unique identifier for a client. [optional]
memberICA Long Interbank Card Association number assigned by Mastercard to the client. [optional]
userNumber String 30 The unique identifier of a user assigned by the client.
firstName String 50 User's first name [optional]
lastName String 50 User's last name [optional]
motherMaidenName String 30 User's mother maiden name [optional]
gender String 1 The ISO code used to determine the gender of the User [optional]
birthDate String 10 User's date of birth in the format yyyy-MM-dd [optional]
nationalIdentifier String 50 User's unique identifier assigned by the national or government system. For example, passport number or tax identification number [optional]
businessPhoneNumber String 25 User's business phone number [optional]
mobilePhoneNumber String 25 User's mobile phone number [optional]
homePhoneNumber String 25 User's home phone number [optional]
emailAddress String 120 User's email address [optional]
vip Boolean Used to assign VIP status to a user, default value is false [optional]
employee Boolean Used to assign Employee status to a user, default value is false [optional]
address UserAddress User's address details [optional]
account Account User's account details [optional]

Sample JSON

User 

{
  "companyId": "611532",
  "userNumber": "C02333333325",
  "firstName": "John",
  "lastName": "Smith",
  "motherMaidenName": "Jennifer",
  "gender": 1,
  "birthDate": "1975-03-11",
  "nationalIdentifier": "324-56-7574",
  "businessPhoneNumber": "+1(0)1234567890",
  "mobilePhoneNumber": "+1(0)1234567891",
  "homePhoneNumber": "+1(0)1234567892",
  "emailAddress": "[email protected]",
  "vip": true,
  "employee": false,
  "address": {
    "addressLine1": "10 Upper Bank Street",
    "addressLine2": "Chesterfield",
    "addressLine3": "Canary Wharf",
    "addressLine4": "Tower Hamlets",
    "city": "London",
    "countryCode": "ENG",
    "postalCode": "E1 6AN",
    "stateProvinceCode": "JS"
  }
}

User with Account 

{
  "companyId": "611532",
  "userNumber": "C02333333325",
  "firstName": "John",
  "lastName": "Smith",
  "motherMaidenName": "Jennifer",
  "gender": 1,
  "birthDate": "1975-03-11",
  "nationalIdentifier": "324-56-7574",
  "businessPhoneNumber": "+1(0)1234567890",
  "mobilePhoneNumber": "+1(0)1234567891",
  "homePhoneNumber": "+1(0)1234567892",
  "emailAddress": "[email protected]",
  "vip": true,
  "employee": false,
  "address": {
    "addressLine1": "10 Upper Bank Street",
    "addressLine2": "Chesterfield",
    "addressLine3": "Canary Wharf",
    "addressLine4": "Tower Hamlets",
    "city": "London",
    "countryCode": "ENG",
    "postalCode": "E1 6AN",
    "stateProvinceCode": "JS"
  },
  "account": {
    "accountNumber": "5330333671236516",
    "status": "NEW",
    "productCode": "7274VCC",
    "programEnrollmentCode": "ZXSzM",
    "openDate": "2015-01-01",
    "enrollmentDate": "2018-03-11"
  }
}