API Basics

The Vesicash API gives you access to all escrow features that you can use on our dashboard and lets you extend them for use in your application. The API allows you create, accept, and manage escrow transactions between yourself and another party, or between two other parties. It also safeguard customers on your platform - allowing your customers to create, initiate, fund, hold and release payments from our escrow vault.

Create a test business account in our sandbox area, login then generate test API Keys that you can use to make API calls to begin testing the escrow capabilities.

When you've fully tested and are ready to go live, you can proceed to creating a live business account and of course, login then generate live API Keys to replace the test keys.

Making a Request

Next to each endpoint is the expected method to access that endpoint. All you need to do is pass in the specific parameters as will be shown in this documentation, and you can make calls to the endpoints.

Input/Output Format

Both request body data and response data are formatted as JSON. Content type for responses will always be application/json.

Generally, all responses will be in the following format:

Standard API response format

{ "status": [string] - indicating whether or not the request could be processed, "code" : [integer] - indicating the request code, "message": [string] - contains the result of the action that was processed, "data": [object] - contains the payload of the action that was processed }

Base URL

All API requests must be made over HTTPS to the following base URL, and unencrypted HTTP connections are not supported.

Ensure you send all requests to the right url. For example, when using the sandbox API keys, make sure you send all requests to the sandbox url to prevent getting "Access denied" error. Similarly, when using the live keys, make sure you send all requests to the live url.