1.0 Authorization

The Wallet APIs can be authenticated by using a generated access token which would be shared via an email along with other necessary credentials. This is shared after all necessary discussions with the product team has been concluded.

NB: In order to call our endpoints it’s necessary to pass the X-VANT-KEY as an authorization header for every request.

2.0 Base Url

All requests to the API must be done using the web API URL below.

Test Environment: https://dev.vantapp.com/api/partner

Live Environment: https://api.vantapp.com/api/partner

The following operation types are supported.

Transfer Services - Allows outward transactions from accounts.

transfer/banks – This endpoint retrieves all banks
/transfer/verify-account - This endpoint allows you to get beneficiary details
/transfer/initiate - This endpoint allows you to initiate an intra or inter funds transfer

Wallet Account - Allows a client to set up a new account/wallet or query wallet.

/client/create - This endpoint allows you to create a client with BVN as mandatory
/client/all-wallets - This endpoint allows you to get a list of all the wallets created by you
/client/enquire-walllet - This endpoint allows you retrieve a wallet details including available balance, using their account number.
/checkout - This endpoint allows you to create virtual account for swift checkout.

Transaction Enquiry

/transaction/all – This endpoint allows you retrieve all transactions from your account.
/transaction/reference – This endpoint allows you retrieve transactions by their reference no.
/transaction/account – This endpoint allows you fetch all transactions for a wallet account no

3.0 Notifications

Inward Transfer Notification

For both reserved wallet account number and checkout temporary account number, a webhook is shared with us so you can be notified for inward credit transactions. The webhook is to be shared both in the testing and production environment. Its request will be sent in this format.

{
"event":"transfer",
"reference": "VNT-weiuubui3b3n4",   
"amount": "1000",    
"account_number": "1010123498",   
"originator_account_number": "2910292882",   
"originator_account_name": "AZUBUIKE MUSA DELE",     
"originator_bank": "000004",   
"originator_narration": "test",
"status": "successful",
"meta": {},
"timestamp": "2021-01-11T09:34:55.879Z",
"sessionId": "00001111222233334455" 
}

"reference" — This is prefixed by your wallet name followed by a random string.

“amount” — This is the amount sent to the wallet account.

“account_number” — This is the account number credited with the inward transfer.

“originator_account_number” — This is the initiator’s account number.

“originator_account_name” — This is the initiator’s name.

"originator_narration" – This is the narration or remark from the sender.

“originator_bank” — This is the initiator’s bank code.

“status” — This is the status of the transaction.

“meta” — This is the meta data you paassed in for the transaction.

“timestamp” — Timestamp of the transaction.

Reserved Wallet Creation Notification

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": "+2348060765447",
		"email": "ucheisnaanih21@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": {
		"phone": "+2348060765447",
		"email": "ucheisnaanih21@gmail.com",
	},
	"statusCode": 400,
	"message": "error creating user account"
}