This is the endpoint that creates a new wallet based on the configuration and implementation set on the client
Request Message Description
| Field# | Field name | Data type | Required | Max Length | Description | Options |
|---|---|---|---|---|---|---|
| Field# | Field name | Data type | Required | Max Length | Description | Options |
| 4 | channel | String | yes | 30 | channel sending request | “WEB” or “USSD” or “SERVICE” or “MOBILE” |
| 14 | city | String | no | 200 | city – for location of wallet holder | |
| 17 | countryCode | String | no | 200 | country code – for location of wallet holder | |
| 8 | emailAddress | String | no | 200 | email address of wallet holder | |
| 5 | encryptedPin | String | no | 32 | encrypted Pin | |
| 6 | txnRef | String | no | 200 | external system transaction reference | |
| 9 | firstName | String | no | 200 | first name of wallet holder | |
| 10 | lastName | String | no | 200 | last name of wallet holder | |
| 7 | mobileNr | String | no | 200 | mobile number of wallet holder | |
| 1 | name | String | yes | 200 | name of wallet | |
| 11 | nameOnCard | String | no | 200 | name on card for wallet holder | |
| 15 | postalCode | String | no | 200 | postal code – for location of wallet holder | |
| 16 | state | String | no | 200 | state – for location of wallet holder | |
| 2 | status | String | yes | 30 | status of wallet | “ACTIVE” or “INACTIVE” |
| 12 | streetAddress | String | no | 200 | street address – for location of wallet holder | |
| 13 | streetAddressLine2 | String | no | 200 | street address line 2 – for location of wallet holder | |
| 18 | domain | String | no | 200 | wallet domain | |
| 3 | ids | Map | yes | wallet identifiers |
Endpoint
Base URL : https://api-gateway.interswitchng.com
Request: POST /generic-wallet/api/v1/wallets/create
Header
Content-Type: application/json
Authorization: {passport generated bearer token}
Creating New Wallet with PIN
This creates a new wallet , a card and sets the pin of the card to the given pin based on clients implementation and configuration.
Sample Request
{
"name": "TEST_NIN",
"status":"ACTIVE",
"ids":
{
"PHONE":"08012345678"
},
"channel":"WEB",
"domain" : "ISW",
"encryptedPin":"31d7e6e95aa309fc21127391833733eb",
"firstName":"name",
"lastName":"surname",
"city":"lagos",
"postalCode":"100011",
"streetAddress":"16, oko awo street",
"streetAddressLine2": "Victoria Island",
"state" : "Lagos"
}
Sample Response (Success)
{
"statusCode": "200",
"responseCode": "00",
"responseMessage": "Successful",
"errors": null,
"modelList": null,
"count": 0
}
Creating New Wallet Without PIN
{
"name": "TEST_NIN",
"status":"ACTIVE",
"ids":
{
"PHONE":"08012345678"
},
"channel":"WEB",
"domain" : "ISW",
"firstName":"name",
"lastName":"surname",
"city":"lagos",
"postalCode":"100011",
"streetAddress":"16, oko awo street",
"streetAddressLine2": "Victoria Island",
"state" : "Lagos"
}
Sample Response (Success)
{
"statusCode": "200",
"responseCode": "00",
"responseMessage": "Successful",
"errors": null,
"modelList": null,
"count": 0
}