API Reference

An endpoint to create a reserved wallet for your users

Log in to see full request history

When a request is made to create a reserved wallet, it is handled asynchronously. This means that instead of waiting for an immediate response, the system processes the request in the background. Once the process is complete, a webhook notification is sent to inform you of the result.

How It Works

  1. Asynchronous Processing
    The request is received and processed in the background. This allows your application to continue running without being blocked by the account creation process. The initial response "BVN lookup and account creation are being processed" is returned

  2. Webhook Notification
    After processing, the system sends a webhook notification to your webhook url. This notification contains details about whether the request was successful or failed. Make sure this is set in the settings tab.

Webhook Payload Examples

Success Notification

When the account creation is successful, the webhook sends the following JSON payload:

{ "event": "account_creation", "data": { "name": "Pakam-JOSHUA937", "firstname": "JOSHUA", "lastname": "ISAAC", "phone": "+2348160765447", "email": "uchennaanih21@gmail.com", "wallet_balance": 0, "account_numbers": [ { "account_name": "MERCHANT(JOSHUA ISAAC)", "account_number": "9977573760", "bank": "Providus" } ] }, "statusCode": 200, "message": "user account created" }

Failure Notification

If the account creation fails (for example, due to an invalid BVN), the webhook sends the following JSON payload:

{ "event": "account_creation", "error": "Invalid BVN", "data": { "email": "uchennaanih21@gmail.com", "phone": "+2348160765447" }, "statusCode": 400, "message": "error creating user account" }
Body Params
string
required
Defaults to jane@gmail.com
string
required
Defaults to 08078325446
string
required
Defaults to 2222222222
string
required
Responses

Language
Credentials