Wallet API
Information about our Wallet API.
Overview
Our Wallet API allows you to transfer money between Viva Wallet accounts. You can also to view information on your wallets.
API calls
Our Wallet API consists of the following API calls:
1. Balance transfer
This API Call allows you to transfer money:
- From any of your Viva Wallet accounts to any Viva Wallet account of another merchant
- Between your Viva Wallets accounts
For a successful transfer to take place:
- Source wallet must have sufficient funds to perform the operation
- Source and target wallets must use the same currency
Before you can use this API call you need to enable transfers between accounts in the Viva Wallet banking app:
Log in to Viva Wallet, demo or live , and select the required account.
Go to Settings > API Access.
Select the Allow transfers between accounts checkbox as shown below:
👉 You should enable the “Allow transfers between accounts” option only for the source wallet. If you don’t enable this option, then no balance transfer will be possible.
Find out more about the Balance Transfer API call and its parameters
2. Retrieve wallets
Use this API Call to retrieve details of all wallets set up within your Viva Wallet account.
Find out more about the Retrieve Wallet API call and its parameters
Get Support
If you would like to integrate with Viva Wallet, or if you have any queries about our products and solutions, please see our Get Support page to see how we can help!