Create Wallet

After creating a user, the merchant must create a wallet for that user before the user can hold or transact with supported funds.

Why Create a User Wallet?

The merchant creates a user wallet to:

Provide the user with a wallet for holding supported funds.
Define the currency in which the wallet will operate.
Enable wallet-based transactions for the user.
Generate a unique wallet_id that can be used in subsequent wallet operations.

Create User Wallet

POST {{base_url}}/api/v1/user/subwallet

Request Headers

Name	Type	Description
`Authorization`*	String	`Bearer ${api_key}` — your activated merchant API key.
`x-merchant-ref`*	String	Unique reference identifying the merchant making the request.
`Content-Type`	String	`application/json`

Request Body

Name	Type	Description
`user_ref`	String	The unique reference of the user for whom the wallet is being created.
`currency`	String	The currency of the wallet, for example `NGN`.
`chain`	String	The blockchain chain for the wallet. Leave empty when creating a fiat wallet.

Sample Request

{
  "user_ref": "UREFB71CBD5EE9BE4AEFB0A1587839EAD87D007QQ",
  "currency": "NGN",
  "chain": ""
}

Response

`200 OK`

{
  "status": "success",
  "message": "Created successfully",
  "data": {
    "wallet_id": "LBWNGN45E846EC354C4B53ACBF69979176C1E5009SH",
    "currency": "NGN",
    "status": true
  }
}

Response Fields

Key	Type	Description
`wallet_id`	String	Unique ID assigned to the newly created wallet. Store this value for future wallet operations.
`currency`	String	Currency of the created wallet, for example `NGN`.
`status`	Boolean	Indicates whether the wallet was successfully created. `true` means the wallet was created successfully.

Updated 24 days ago

Did this page help you?