Virtual Registration

Virtual Registration Request service uses POST method to register and link a user to a virtual card.

In the request, the KYC details are sent and validation is done on the Cards API. The ID are verified at Smile ID(if enabled at partner) using the idType and idValue.
In the response the customer ID, last 4 digits of PAN, and a passcode is sent in response. The passcode is used to login into the cardholder portal.

Endpoint

/MFSAfricaCard/v1/virtualRegistration

Request

{
    "accountSource": "OTHER",
    "address1": "Lane 1",
    "address2": "lane 2",
    "address3": "Lane 2",
    "alternatePhoneNumber": {
      "countryCode": "256",
      "number": "123456789"
    },
    "birthDate": "17-JAN-1985",
    "bvn": "0000001",
    "cardType": "VPC",
    "city": "Lagos",
    "country": "NG",
    "emailAddress": "[email protected]",
    "firstName": "John",
    "idType": "PASSPORT",
    "idValue": "32332",
    "lastName": "John",
    "middleName": "",
    "mobilePhoneNumber": {
      "countryCode": "256",
      "number": "988765431"
    },
    "otherAccountId": "554353",
    "otherCompanyName": "XYZ",
    "postalCode": "212122",
    "preferredName": "John Doe",
    "solId": "4334",
    "stateRegion": "LA",
    "notificationMethod": "NONE"
  }

Field (* required field)	Type	Description
accountSource*	string	This field contains “SKYE”, “ROAMWARE”, ”OTHER”
address1*	string
address2	string
address3	string
alternatePhoneNumber	object	"alternatePhoneNumber": { "countryCode": "933", "number": "937256786" }
birthDate*	string	This field contains the format: DD-MMM-YYYY (17-JAN-1985)
bvn	string	Bank Verification Number for Nigeria only
cardType*	string	VPC - Virtual Prepaid Card VCC - Virtual Companion This is dependent on the type of program you been registered
city*	string
country*	string	This field contains the two character country code
emailAddress*	string
firstName*	string	This field contains the Card holder first name
idType*	string	“PASSPORT”, “NATIONAL_ID”,“DRIVERS_LICENSE”,“ALIEN_CARD”, “VOTER_ID”, “SSNIT”, “NATIONAL_ID_NO_PHOTO”,'OTHER'
idValue*	string	This field contains the value corresponding to the IDType
lastName*	string	This field contains the Card holder last name
middleName	string	This field contains the Card holder middle name
mobilePhoneNumber	object	"mobilePhoneNumber": { "countryCode": "933", "number": "937256786" }
otherAccountId	string	Client / Partner specific ID that uniquely identifies account holder
otherCompanyName	string	Information embossed on second line of card(Physical card only)
postalCode	string
preferredName*	string	Name to be displayed on the Card
solId	string	Bank branch associated with the card
stateRegion*	string	Two character State/Region code specific to Country
notificationMethod*	String	“SMS” or “NONE”. “SMS” will send card details to the customer via SMS. “NONE” will send no SMS.

Response

{
    "errorCode": "0000",
    "registrationCustomerID": "12702559",
    "registrationLast4Digit": "9198",
    "registrationPassCode": "4158",
    "errorMessage": "SUCCESS"
}

Field	Type	Description
errorCode	string	Error Code
errorMessage	string	Error Message
registrationCustomerID	integer($int64)	The customer ID of the newly created account holder
registrationLast4Digit	string	The last four digits of 16 digit PAN of the new card
registrationPassCode	string	The Registration Pass Code of the new card