APIs

Overview

The Gateway API allows you to process payment transactions using JSON based requests and responses. The API uses a single endpoint for real and test transactions.

📘

Before you begin

You’ll need to have a Backoffice user account. This account is provided by Client Services. If you don't have a merchant account yet head over to the First steps section.
You will only be able to run real transactions once your integration is fully tested and approved.

👍

Vendo's Gateway API Recurring Billing Options

Vendo’s Gateway API provides two flexible options for handling recurring billing:

  1. Manual Recurring Billing via Tokenization: You have the option to manage recurring billing directly on your side by using our payment tokenization feature. Simply store the payment token for each user, and call the API whenever you need to charge them on a recurring basis.
  2. Automated Recurring Billing by Vendo: Alternatively, you can let Vendo manage the recurring billing process for you. Our platform will automatically schedule and process payments on your behalf. You’ll receive postback notifications to keep your platform informed of each successful recurring payment.

👍

Testing the integration

Check here for details on how to perform test transactions.

Getting started

You'll need 3 things before you can start implementing and testing the implementation:

  • Your Merchant ID
  • One of your Site IDs
  • The API secret for tests

Read on to learn how to obtain those:

Step 1

  • Log in to the Backoffice and go to Catalog > Merchants.
  • Select your Merchant name from the list.

Step 2

  • Get your merchant id, which is located at the top of the page.
  • Scroll down to the bottom of the page and select Gateway API Secret for Tests and copy the code.

Step 3

  • Go to Catalog > Sites and get an ID for the site you want to test the API against (you may create a test site first if you prefer).

Step 4

  • Integrate the Gateway Payment API and test it.
  • Remember that the JSON parameters must be POSTed in the body of the HTTP request.
  • Please allow at least 30 seconds for the response to arrive. Set connection and transfer timeouts to 30 seconds or more.
  • Once you’ve successfully tested the API, inform Vendo and the team will generate the API secret for real transactions.