Single enrollment endpoint

Endpoint

POST {scheme}://{host}:{port}/virtual-card/api/v1/cards/enrol

Request Type is application/json

Authorization: {passport generated bearer token}

Request Message description

Field#	Field name	Data type	Max length	Required	Description
1	cardName	String	100	Yes	e.g Emeka Ugo
2	pin	Numeric	4	Yes	e.g 4040
3	cardPan	String	50	Yes	e.g 5060666666666666666
4	city	String	50	Yes	e.g Surulere
5	country	String	50	Yes	e.g Nigeria
6	countryCode	String	50	Yes	e.g NG
7	expiryDate	String	50	No	e.g 2505
8	cvv	Numeric	3	No	e.g 366
9	primaryMobileCountryCode	String	3	Yes	e.g NGN
10	primaryMobileNumber	String	25	Yes	e.g 2348075884533
11	state	String	50	No	e.g Lagos
12	title	String	50	No	e.g Mr

Plain Sample Request

{
      “cardName”:”Adewoye Adeyelr”,
      “pin”: “1234”,
      “cardPan”:”5061810000000152049″,
      “city”:”la”,
      “country”:”NG”,
      “countryCode”:”NG”,
      “expiryDate”:”1800″,
      “cvv”:”333″,
      “primaryMobileCountryCode”:”NGN”,
      “primaryMobileNumber”:”2348065186177″,
      “state”:”Lagos”,
      “title”: “Mr”
}

Encrypted Sample Request

{
   “data”:”T4DZPBE42uzXl61X+3D47lTyB1uXkvgTY/Q2ATx5/A2Qm/8fAlkbJbMtmpGciOCIOimf44BRnntAsX7mn5UwFd6yE+fnVQvWLti+MYKud6ywK5fckw8b0ZrzR5+nvNLEaTA9jFptCBq0nNN1tCk7QzcgajBbad1/pbC8QUf7oYZ1rVqQ/Kghyi0aC5tIyL2h3ul/jiPyjEmb18I0xTSz3w==”
}

Response Message description

Field#	Field name	Data type	Max length	Required	Description
1	responseCode	String
2	responseMessage	String
3	message	String
4	status	String

Sample Response

{

       “responseCode”: “00”,

       “responseMessage”:”Successful”,

       “data”: { 

           “status”:”SUCCESSFUL”,

           “message”:”Card successfully enrolled”

       }

}

Multiple enrollment endpoint

Endpoint

POST {scheme}://{host}:{port}/virtual-card/api/v1/cards/batch/enrol

Request Type is Multi-part form-data

Authorization: {passport generated bearer token}

Request Message description

Field#	Field name	Data type	Max length	Required	Description
1	file	File		Yes	Upload .xls or .xslx file type

Sample Response

{

       “responseCode”: “00”,

       “responseMessage”:”Successful”,

       “data”: { 

           “status”:”PROCESSING_IN_PROGRESS”,

           “message”:”The batch processing is in progress”

       }

}