Introduction

Documentation Sections Walkthrough

Welcome to the UPI PSP Backend API Reference Document. This doc consists of the comprehensive information about our Server-to-Server APIs. We use application/json content type for our request and response.

This documentation is designed to guide you through each API in detail. From API descriptions to the step-by-step flow, everything you need is outlined in the sections below. Each section includes crucial information about the API's structure, including the Request and Response body specifications.

Before you dive into the APIs, we recommend familiarizing yourself with the Requestlink icon and Responselink icon structure. This will provide you with essential insights into prerequisites and overall formatting, ensuring a smooth integration process.

The docs covers different use cases of a merchant for payments processing :

  • 1st Transactionslink icon (Payins & Refunds) where merchants want to acquire/collect money from user on demand basis for one-time payments & refund against original transaction.

  • 2nd Mandateslink icon (UPI AUTOPAY) where merchants want to acquire/collect money from user on regular basis for recurring payments by one-time mandate creation(registration). This would mostly be used for Subscriptions, Bill Payments, Investments, Insurance Payments, Donations, Wallet Top-ups etc.

  • 3rd Payoutslink icon where merchants want to disburse money from Merchant Accounts to Customer Accounts instantly. It can be also used for Customer Account Verification via Penny Drop. This would mostly be used for Rewards, Cashbacks, Incentives etc.

  • 4th Sub-Merchantslink icon where parent merchant want to enable its different LOBs(Line of Business) or franchise/branches to acquire/collect money via Intent/Collect or unique QR codes via any UPI app. Sub-merchant payments can be one-time or recurring depending upon use case & integration.

Last updated 10 months ago