UPI
Unified Payments Interface (UPI) is an alternative payment method in India. With UPI, customers can enjoy a seamless checkout experience, with a choice of fulfilling their payments in direct debiting from their registered account.
Introduction
UPI is an alternative payment method in India that offers a convenient way for customers to pay for goods and services. Integrating UPI with Payrails allows you to provide a fast, easy-to-use payment option for your customers while leveraging our platform to route the payment to any Payment Service Provider (PSP). This guide will explain the process of integrating UPI into your app or website using Payrails.
Pre-requisites
Before you start accepting UPI payments with Payrails, there are a few requirements you must meet:
- Integrate with Payrails using one of our SDKs or our API
- Configure a new integration account for UPI via one of the following Payment Service Providers:
Boku, dLocal and Pinelabs. - Enable UPI as a payment option.
- Make sure you're sending the UPI specific meta fields (found under Merchant configurations -> Meta fields on your Payrails dashboard and in the examples below) in your requests.
Ways to integrate UPI
Payrails SDK
The simplest way to use UPI with Payrails is to use our drop-in in your checkout flow. With this integration type, no additional development work is required to accept payments with UPI.
Server-to-server integration
The simplest way to use UPI is by completely managing your own client-side implementation, and using Payrails APIs with a server-to-server integration to process payments with UPI. With this approach, follow the documentation below to build UPI into your applications:
Parse UPI from lookup response
With a server-to-server integration, you can call our lookup payment options endpoint to get available payment options and relevant configurations for each payment method. As the example below, you can see upi
returned as an option of the paymentCompositionOptions
. You can use this value later to authorize payments with Payrails as you can see in the next sections.
{
"name": "lookup",
"actionId": "0bb6413e-cabb-4074-99e6-9e815c69f25b",
"executedAt": "2024-05-08T12:33:21.527395295Z",
"data": {
"paymentCompositionOptions": [
{
"integrationType": "api",
"paymentMethodCode": "upi",
"description": "UPI"
}
]
},
"links": {
"execution": "http://payrails-api.staging.payrails.io/merchant/workflows/payment-acceptance/executions/83c534ac-13b7-43e6-b04b-f3e8b4eb4424",
"authorize": {
"method": "POST",
"href": "http://payrails-api.staging.payrails.io/merchant/workflows/payment-acceptance/executions/83c534ac-13b7-43e6-b04b-f3e8b4eb4424/authorize"
}
}
}
Pass UPI payment method in request to authorize payment with Payrails
You can then make a request to our authorize a payment endpoint with upi
as the paymentMethodCode
. See an example below:
{
"executionId": "c0fd1c51-e709-47e5-bfd1-5d1c98f7d990",
"amount": {
"value": "1000",
"currency": "INR"
},
"paymentComposition": [{
"integrationType": "api",
"paymentMethodCode": "upi",
"amount": {
"value": "1000",
"currency": "INR"
}
}],
"meta": {
"order": {
"lines": [{
"id": "UUID",
"name": "Order Name",
"quantity": 1,
"unitPrice": {
"currency": "INR",
"value": "1000"
}
}]
}
},
"returnInfo": {
"success": "https://mysuccessurl.com",
"error": "https://myerrorurl.com"
}
}
Supported regions / countries
Region(s) | Countries |
---|---|
Asia | 🇮🇳 India |
Supported workflows and services
Workflow | Supported |
---|---|
Available via Payrails SDK | ✔️ |
Available via Payrails API | ✔️ |
Delayed / Manual Capture | ✖️ |
Instant Capture | ✔️ |
Cancel / Void | ✔️ |
Refund / Reverse | ✔️ |
Save Instruments | ✖️ |
Merchant Initiated Transaction (MIT) | ✖️ |
Interoperability | N/A |
Updated 8 days ago