Register

Wallet Creation API

Create customized wallets with full banking capabilities.

How does it work?

The Wallet Creation API allows clients request the creation of customized wallets. These wallets can only be managed and operated using the channel or application of choice by the requesting client.

  1. The client makes a request on behalf of the customer to generate a wallet.

  2. The client gets a PENDING status of while awaiting wallet generation.

  3. Client receives a notification of wallet details via a callback URL.

Go Live

Step 1 - Generate Wallet for Partnership

Request URL

POST - {baseURL}/wallet-creation/api/CustomerAccount/GenerateWalletAccountForPartnerships/Request

Try it out !

  1. Client initiates request on behalf of customer using the request model below.

  2. Client is required to pass a valid x-api-key value in the header of their request. This value would be provided by the bank.

  3. NIN is mandatory.

  4. A successful call to this endpoint would

    • check validity of NIN provided

    • send SMS OTP to the phone number on NIN

    • a trackingId is returned to the client to be used for validation of NIN in step 2

  5. Client proceeds to step 2, in order to validate NIN.

Step 2 - Validate NIN using OTP

Request URL

POST - {baseURL}/wallet-creation/api/CustomerAccount/GenerateWalletAccountForPartnershipsV2/otp

Try it out!

  1. Client provides a medium/interface for customer to input OTP received from step 1.

  2. Client initiates request on behalf of customer by sending otp, trackingIdandphoneNumber used in step 1 above.

  3. Client is required to pass a valid x-api-key value in the header of their request. Same as in step 1

  4. A successful call to this endpoint would return a PENDING status of wallet generation. The wait time for wallet generation is a maximum of 10 minutes.

  5. Client receives a callback once wallet generation process is completed. The callback model can be seen below.

The Callback Model

Clients are to build their callback following the specification below. Your callback URL would be profiled to your assigned channelId.