Welcome!

Use the Vendy API to collect payments from your customers online and offline, hold the funds in wallets, and send money out to bank accounts.

Authentication

Send your AccessKey and SecretKey with every request.

Payments

Request payments by WhatsApp, payment link or bank transfer.

Settlement

Check wallets and pay out to your saved accounts.

Dedicated Accounts

Give each customer their own account number.

Transfers

Send money to any bank account, one at a time or in bulk.

Webhooks

Get notified when payments and payouts change.

New to Vendy? Create an account on the Vendy Dashboard, then get your keys from Settings → APIs. Read Errors before you go live.

API Environments

Vendy API operates in two environments: live and sandbox.

Environment Host	Usage	URL
Sandbox API	For development purposes and to test Vendy's features without affecting real data.	https://api.staging.myvendy.com
Live API	To access real-time data when your product is ready to live	https://api.myvendy.com
Live Dashboard	Sign up on the live dashboard when you're ready to go live	https://dashboard.myvendy.com

API Interaction

Requests

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

Authenticate with both AccessKey and SecretKey headers (aliases: x-access-key/x-secret-key, accesskey/secretkey, access_key/secret_key).
The content-type header must be application/json.
The request body must be in valid JSON format.

Responses

Every response is JSON with the same envelope. See Errors for the format of failed requests.

Field	Type	Description
`status`	Boolean	`true` when the request succeeded
`code`	Integer	`200` on success, otherwise a Vendy error code
`msg`	String	A short description of the result
`error`	String	The same value as `msg`
`data`	Object or Array	The result

Null fields

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

{
    "status": true,
    "code": 200,
    "msg": "Transaction Sent",
    "error": "Transaction Sent",
    "data": {
      "refid": "1238912318231238",
      "vendref": null
    }
}