API Reference

Merchant Code

Describes the steps required to collect using merchant code

Collect payments with Merchant Code

Introduction

Vendy merchant code allows merchants to generate a unique code for accepting payments via Vendy's WhatsApp bot. By following the instructions in this guide, you will be able to get started with Vendy's payment solution seamlessly.

Table of Contents

Getting Started via the Merchant App

To begin accepting payments through Vendy's WhatsApp bot, follow the steps below:

  1. Sign up for a developer account by downloading the Vendy Merchant app on either the Google Playstore or Apple Appstore

  2. Once you're fully onboarded, Navigate to the Settings page in the Merchant Dashboard.

  3. Locate the "Merchant Code" section and click on it to generate your unique 4-digit code. If you're an existing merchant, you can simply click the "Generate Merchant Code" button in the same section.

Getting Started via the Merchant Dashboard

To begin accepting payments through Vendy's WhatsApp bot, follow the steps below:

  1. Sign up for a developer account by visiting the Vendy Dashboard.

  2. Navigate to the Settings page in the Merchant Dashboard.

  3. Locate the "Merchant Code" section and click on it to generate your unique 4-digit code. If you're an existing merchant, you can simply click the "Generate Merchant Code" button in the same section.

Getting Started via API

If you prefer to generate a merchant code programmatically using Vendy's API, follow the steps outlined below:

  1. Make a GET request to the https://api.vendy.money/business endpoint to retrieve the details of your business. Ensure that the code field is empty.

  2. If the code field is empty or NULL, make an empty POST API request to https://api.vendy.money/business/:id/request-code to generate a unique code for your business. The response will include the business details along with the generated code.

  3. Repeat step 1 to confirm that the code has been generated and assigned to your business.

  4. Once you have the code, you can choose to print it out or share it with your customers through various communication channels.

How Customers Can Pay the Merchant

To initiate the payment process for your customers, they can follow these steps:

  1. New customers should visit https://vendy.money/whatsapp to start a conversation with the Vendy bot. Existing customers who have previously made payments through Vendy's WhatsApp bot can simply find the chat with the Vendy WhatsApp bot and send a message saying 'Hi' or 'Hello'.

  2. The Vendy WhatsApp bot will prompt the customer to enter the Vendy merchant code assigned to the business they want to pay.

  3. The customer should enter the unique merchant code generated for the merchant, as described in the "Getting Started" section above.

  4. If the entered code is correct, the WhatsApp bot will ask the customer to specify the amount they would like to pay to the merchant.

  5. Once all the details are confirmed, an invoice will be automatically generated and sent to the customer via WhatsApp. The customer can then proceed with the Vendy payment process.

Payment Methods Supported

Vendy supports various payment methods for customers to conveniently make payments to the merchant. The available payment methods include:

  • Direct bank payments
  • Debit/credit cards
  • Pay with bank transfer
  • Payment through Vendy wallet
  • Buy Now & Pay Later loans (BNLP)

Feel free to explore and leverage these payment methods to offer your customers a seamless payment experience.

That's it! You have successfully integrated Vendy's new feature that enables merchants to accept payments through Vendy's WhatsApp bot. If you have any further questions or require additional assistance, please refer to the Vendy documentation or contact our support team.