Vesicash API V1


The Vesicash widget is an alternative way of integrating the vesicash escrow into your existing web or mobile app. It is a less technical way of providing the full escrow capabilities directly to customers on your app.
The widget comes with two main buttons;
  1. 1.
    Make Payment: This enables your customers to easily initiate escrow transactions directly from within your app.
  2. 2.
    Manage Payments: This enables your customers to perform transaction actions such as accepting a transaction, rejecting a transaction, accepting shipment, rejecting a shipment, etc as well as updating their escrow profile and bank details to easily receive funds from escrow.

Initial Setup

To get started with integrating the widget, you are required to have created a vesicash business account, and generate API keys from the integrations tab in the dashboard which you'll use in the widget. Once this is done, proceed to configuring the widget by following the steps below:

Initial Setup

From your vesicash dashboard, Click on Integrations menu on the side bar => Click on integrations method to see the screen below:
Select widget option, then scroll down and click "Customise your widget" button:
In the pop-up window, click on "Get Started" button to see the page where you can customise your widget:
When you finish your customization, click the "Submit" button and you'll see a preview of how your widget will look like when your customers interact with it. Now that you have finished your customization, follow these steps to integrate the customized widget into your website or app:

Step 1

Copy the sample script generated on this page and paste it on a page in your website or app where you want your customers to see the widget:
The code above displays two main buttons which your customers sees to begin interacting with the escrow.
The buttons can be separated and put in any desirable place within your app. You only have to put the <script> tag once above the buttons.

Step 2

Click on Step 2 from the screen above to see a screen like this:
Paste this code just before the closing </body> tag in your app.
The script above is responsible for carrying out the escrow actions whenever a customer clicks the buttons in step 1.
  • It is important to note that the buttons in step 1 above will not perform any actions if this script is not present in your code. Ensure this script is pasted below the script in step 1 before proceeding.

The Result

If you follow the steps above successfully, customers on your app will be able to this:
The escrow buttons
When a customer clicks on the New Escrow button, they see the page below to confirm their email address and phone number:
When they click Next button, they are taken to the page below to initiate a escrow transaction and then supply the details of the transaction:
Create New Transaction
After successfully entering the transaction details and clicking the submit button, they see a success page below that indicates that their transaction has been successfully created.
Transaction status success page
Upon clicking the Manage Escrow button, the customer is directed to login using the email and phone number or email and password to begin carrying out other actions on the widget:
Login area to manage transactions
Upon successful login, users are shown the page below where they can utilize the full escrow capability directly from the widget.