API Reference

Welcome!

Welcome to Vendy's API documentation.

Hi! You can use our APIs to make and receive payments offline and online via a variety of payment channels.

  1. To learn more about Vendy click here.

  2. Create a vendy account and sign up if you haven't.

  3. For further information about payments, visit the payment transaction overview.

  4. Click here to create Webhooks.

  5. Are you a merchant and would like to create a business or business on the platform click here.

  6. To learn about the different payout processes click here.

  7. You can learn more about wallets here.

  8. Visit the API overview section to learn about our APIs.

  9. Want to know the differences between our APIs? Then click here.

API Environments

Vendy API operates in two environments: live and staging.

Environment HostUsageURL
Staging APIFor development purposes and to test Vendy's features without affecting real data.https://api.staging.myvendy.com
Staging DashboardSign up on the staging dashboard to test Vendy's featureshttps://dashboard.staging.myvendy.com
Live APITo access real-time data when your product is ready to livehttps://api.myvendy.com
Live DashboardSign up on the live dashboard when you're ready to go livehttps://dashboard.myvendy.com

API Interaction

Requests

The Vendy API accepts POST and GET requests. Your requests must follow these formal requirements:

  • The authorization header must contain your secret API key as a bearer token.
  • The content-type header must be application/json.
  • The request body must be in valid JSON format.

Responses

The Vendy API responds with HTTP codes to indicate status and errors. The API provides all responses in standard JSON format.

Null fields

When no information is present, data fields may return null values:

{
    "status": true,
    "code": 200,
    "msg": "Transaction Sent",
    "data": {
      "refid": "r1238912318231238"
    }
}