LogoLogo
Document ValidationsPayment Methods
  • Welcome to LimePay API Docs
  • Getting Started with Lime-Pay
  • API Documentation
    • Deposits API
      • Technical and Security Aspects
        • Calculating the Signature
      • Endpoints
        • Deposit Creation Endpoint
          • Notifications
        • Deposit Status Endpoint
        • Payment Methods Endpoint
        • Currency Exchange Endpoint
        • Refund Creation Endpoint
          • Notifications
        • Refund Status Endpoint
      • Payment Methods
        • 🌍Africa
          • 🇧🇯Benin
          • 🇧🇼Botswana
          • 🇨🇲Cameroon
          • 🇨🇬Congo Brazzaville
          • 🇨🇩Congo DRC
          • 🇪🇬Egypt
          • 🇬🇦Gabon
          • 🇬🇭Ghana
          • 🇨🇮Ivory coast
          • 🇰🇪Kenya
          • 🇲🇼Malawi
          • 🇲🇱Mali
          • 🇳🇬Nigeria
          • 🇷🇼Rwanda
          • 🇿🇦South Africa
          • 🇹🇿Tanzania
          • 🇹🇬Togo
          • 🇺🇬Uganda
          • 🇿🇲Zambia
        • 🌏Asia
          • 🇧🇩Bangladesh
          • 🇨🇳China
          • 🇭🇰Hong Kong
          • 🇮🇳India
          • 🇮🇩Indonesia
          • 🇯🇵Japan
          • 🇲🇾Malaysia
          • 🇵🇰Pakistan
          • 🇹🇭Thailand
          • 🇹🇷Turkey
          • 🇻🇳Vietnam
      • API Codes
    • Cashouts API
      • Technical and Security Aspects
        • Calculating the Payload-Signature
      • Endpoints
        • Cashout Creation Endpoint
          • Notifications
        • Cashout Status Endpoint
        • Cashout Update Status Endpoint
        • Cashout Cancellation Endpoint
        • Cashout Bank Codes
      • Countries Validations
        • 🌍African Countries
          • 🇧🇼Botswana
          • 🇨🇲Cameroon
          • 🇨🇬Congo Brazzaville
          • 🇨🇩Congo DRC
          • 🇪🇬Egypt
          • 🇬🇭Ghana
          • 🇰🇪Kenya
          • 🇲🇼Malawi
          • 🇳🇬Nigeria
          • 🇷🇼Rwanda
          • 🇿🇦South Africa
          • 🇿🇲Zambia
          • 🇬🇦Gabon
        • 🌏Asian Countries
          • 🇧🇩Bangladesh
          • 🇨🇳China
          • 🇮🇳India
          • 🇮🇩Indonesia
          • 🇯🇵Japan
          • 🇲🇾Malaysia
          • 🇹🇭Thailand
          • 🇹🇷Turkey
          • 🇻🇳Vietnam
          • 🇵🇰Pakistan
      • API Codes
    • Reconciliation API
      • Technical and Security Aspects
      • Endpoints
      • API Codes
  • Knowledge Base
    • Countries Specifications
Powered by GitBook
On this page
  • Payment Methods
  • Fields required for the OneShot Experience
  • Payer object requirements
  • UPI
  • UPI Seamless
  • Discover the Payment Flows Behind Our Top Methods! 🚀

Was this helpful?

  1. API Documentation
  2. Deposits API
  3. Payment Methods
  4. Asia

India

Check the list of Payment Methods available on India

Last updated 4 days ago

Was this helpful?

Payment Methods

Icon
payment_method
Name
Flow
Payment Type
Iframe supported

UI

UPI

REDIRECT

BANK_DEPOSIT

No

UIS

UPI Seamless

REDIRECT ONE_SHOT

BANK_DEPOSIT

Yes

IMPS

IMPS (Immediate Payment service)

ONE_SHOT

BANK_TRANSFER

Yes

Use the to retrieve the Payment Methods' types, logos and more details.

Fields required for the

Field
Required?

Country

Yes

Amount

Yes

Payer[]

Yes

payment_method

Yes

Payer object requirements

Payment Method Name

document

email

first_name

last_name

phone

All

Yes

Yes

Yes

Yes

No

Other fields not in these lists are optional.

UPI

{
    "invoice_id" : "{{invoiceId}}",
    "amount": "500",
    "country": "IN",
    "currency": "INR",
    "payer": {
        "document": "1233131313",
        "document_type": "ID",
        "first_name": "Rojit",
        "last_name": "Test",
        "phone": "91 2234567890",
        "email": "[email protected]"
    },
 
    "description": "test description",
    "client_ip": "123.123.123.123",
    "back_url": "https://www.lime-pay.com/deposit_cancelled",
    "success_url": "https://www.lime-pay.com/deposit_completed",
    "error_url": "https://www.lime-pay.com/deposit_error",
    "notification_url": "https://www.lime-pay.com/limepay/notify",
    "logo": "https://www.lime-pay.com/limepay.png",
    "test": false,
    "mobile": false,
    "language": "en"
}
{
    "checkout_type": "ONE_SHOT",
    "redirect_url": "https://payment-stg.lime-pay.com/v1/checkout/eyJhbGciOiJIUzM4NCJ9.eyJqdGkiOiI1Njk4Mjg2NSIsImlhdCI6MTcxNDAwNDExMSwiZXhwIjoxNzE1MzAwMTExLCJsYW5ndWFnZSI6InB0In0.m_veUauWLd5oFp9vcVd6q7Sa-ou6__12U5LkqF5XdDm1r0-tonU83KmUJ15FTrcf/IN/UI/4731/10881",
    "iframe": true,
    "deposit_id": 301245385,
    "user_id": "11",
    "merchant_invoice_id": "postmanTest701370365",
    "payment_info": {
        "type": "VOUCHER",
        "payment_method": "UI",
        "payment_method_name": "UPI",
        "amount": 1000.00,
        "currency": "INR",
        "expiration_date": "2024-05-01 22:55:08",
        "created_at": "2024-04-25 00:15:08",
        "metadata": {}
    }
}

UPI Seamless

This method requires the field listed below to generate deposit successfully

The UPI Seamless payment method is only available using the OneShot integration as all fields must be sent.

Field
Required?

Country

Yes

Amount

Yes

Payer[]

Yes

payment_method

Yes

reported_info[].bank_account_number

Yes- Bank account_number = VPA (UPI ID)

VPA is the technical term used for the identifier of the UPI Accounts, for UX and user-facing views, use “UPI ID” instead

VPA Regex: ^[a-zA-Z0-9._\-]{2,50}@[a-zA-Z]{2,50}$

Payer object requirements For UPI Seamless

Payment Method Name
document
email
first_name
last_name
phone

All

Yes

Yes

Yes

Yes

Yes

{
    "invoice_id" : "{{invoiceId}}",
    "amount": "500",
    "country": "IN",
    "currency": "INR",
    "payer": {
        "document": "1233131313",
        "document_type": "ID",
        "first_name": "John",
        "last_name": "Doe",
        "phone": "91 2234567890",
        "email": "[email protected]"
    },
    "payment_method": "UIS",
    "reported_info": {
        "bank_account_number": "test@paymt"
    },
    "description": "test description",
    "client_ip": "123.123.123.123",
    "back_url": "https://www.lime-pay.com/deposit_cancelled",
    "success_url": "https://www.lime-pay.com/deposit_completed",
    "error_url": "https://www.lime-pay.com/deposit_error",
    "notification_url": "https://www.lime-pay.com/limepay/notify",
    "logo": "https://www.lime-pay.com/limepay.png",
    "test": true,
    "mobile": false,
    "language": "en"
}
{
    "checkout_type": "ONE_SHOT",
    "redirect_url": "https://payment.lime-pay.com/v1/checkout/eyJhbGciOiJIUzM4NCJ9.eyJqdGkiOiI4MzMyMzY5NzAiLCJpYXQiOjE3MTM5NTc1OTUsImV4cCI6MTcxNTI1MzU5NSwibGFuZ3VhZ2UiOiJwdCJ9.7URAL4pNP8ARSoBiBJJe0dknC6US2LXra6Q6ginDtH1AZLnsCfOQsPQA-133rtFP/IN/UIS/8261/4",
    "iframe": true,
    "deposit_id": 991814322,
    "merchant_invoice_id": "postmanTest934792442",
    "payment_info": {
        "type": "VOUCHER",
        "payment_method": "UIS",
        "payment_method_name": "UPI Seamless",
        "amount": 500.00,
        "currency": "INR",
        "expiration_date": "2024-04-25 11:19:51",
        "created_at": "2024-04-24 11:19:51",
        "metadata": {
            "qr_code": "data:image/png;base64,encodedimage",
            "provider_link": "upi://pay?pa=paymentdata"
        }
    }

For Customizeable UPI Seamless checkout, Kindly ensure that both the qr_code and provider_link is displayed on the checkout. The provider_link is the intent button that allows end-users make payment right from any of their mobile app. The provider_link is a deep link, therefore, make sure to open it outside of any containers/mobile apps.


Discover the Payment Flows Behind Our Top Methods! 🚀

🌏
🇮🇳
Payment Methods Endpoint
OneShot Experience
UPI Seamless checkout.
UPI Seamless Flow