Jump to Content
Vendy
API Reference
v1.0

Log InVendy
API Reference
Log In
v1.0API Reference

Getting Started

  • Welcome!
  • About Vendy
  • API Overview
  • Errors

Authentication

  • Authorization
    • Authenticate with AccessKeypost
    • Create Authentication Token - Deprecatedpost
    • Verify Authenticationget

Business

  • Registering a Business

PAYMENT APIs

  • Overview
  • Request to pay (PUSH)
    • Request payment Via APIpost
    • Request payment via Checkout Widget
    • Generate Payment URLpost
    • Get Supported Channelsget
  • Pay with Widget (PULL)
  • Merchant Code
    • Generate Merchant Codepost
  • Virtual Accountspost
  • Get transactions recordsget
    • Search Transactionget
    • Get Payment URL Detailsget
    • Get Transactionget
  • Online & Offline collection channels
  • Completing a transaction
  • Payment Methods
    • Vendy Direct
    • Vendy Wallet
    • Pay With Debit Card
    • Pay With Bank Transfer
  • Refunds For Merchants
    • Refunds For Customers

SETTLEMENT APIs

  • Overview
  • Wallets
    • Get Walletsget
    • Create Walletpost
  • Payout Accounts
    • Add a Payout Account Via the Merchant Application
    • List of supported banksget
    • Add a payout accountpost
    • Validate Bank Accountget
    • Make payout account defaultpost
    • Get payout accountsget
    • Remove payout accountpost
  • Payouts
    • Initiate payoutpost
    • Get Payout Detailsget
    • Get Payoutsget
    • Cancel Payoutpost

Webhooks

  • Overview
  • Create Webhookpost
  • Get Eventsget
  • Get Webhooksget
  • Update Webhookspost
  • Delete Webhookpost
  • Get Webhookget
  • Events
    • Transactions events
    • Payouts events

Models

  • Business
  • Wallet
  • Payout
  • Payout Account
  • Webhook
  • Transaction

FAQs

  • Frequently Asked Questions (FAQ)

Payment Provider Integration

  • Introduction
    • Payment Provider Integration
    • Payment Collection Integration
Powered by 

Overview

The Vendy Payment Apis consists of APIs and other methods used to accept funds from customers and adequately monitor progress of these transactions. All endpoints in this section requires that the requests are authenticated.

  • Pay with Widget (PULL)
  • Request to pay (PUSH)
  • Request pay via payment popup widget (PUSH)
  • Generate a payment link
  • Collecting payments with Merchant code (PULL)