Vesicash API Documentation V2
  • Overview
  • API DOCUMENTATION
    • API Basics
    • Authentication
    • Errors
    • Escrow Transactions
      • Create a transaction
      • Get transaction by transaction_id
      • Get transaction charges
      • Get bank lists
      • Get transactions by userid
      • Get all transactions
      • Pay for transaction
      • Send transaction invite
      • Accept transaction
      • Reject transaction
      • Mark milestone as done
      • Accept milestone delivery
      • Reject milestone delivery
      • Request due date extension
      • Approve due date extension
      • Edit transaction
      • Edit milestone
      • Edit party
      • Delete transaction
      • Webhook Notification
    • Merchant Of Record
      • Initiate MoR checkout
      • Get MoR transactions
Powered by GitBook
On this page
  1. API DOCUMENTATION

Authentication

The Vesicash API supports basic authentication using the access Keys (public and private keys) which is accessible via the Vesicash dashboard.

Public keys are fielded from any front-end integration like the Vesicash app. By design, public keys cannot modify any part of you or your customer account details besides initiating transactions and making payments. The private keys however, are to be kept secret. If for any reason you believe your private key has been compromised or you wish to reset them, you can do so from the dashboard.

Usage

Authenticate your API calls by including your private key in the header of each request you make. 

 --header 'accept: application/json' \
 --header 'V-PRIVATE-KEY: v_EnterThePrivateKeyThatWasGeneratedHere' 
 --header 'V-PUBLIC-KEY: v_EnterThePublicKeyThatWasGeneratedHere'

While carrying out api test, we will provide you test keys for test transactions. However, after testing, you must switch to the Live keys in production whilst deploying.

API requests made without authentication will fail with the status code 401: Unauthorized

PreviousAPI BasicsNextErrors

Last updated 9 months ago