• Documentation
  • API Reference
  • Documentation
  • API Reference
Expand All Collapse All
< BACK TO HOME
  • APMs Overview
    • Introduction to APMs
    • APM Input Fields and APIs
    • APM subMethod Class
    • Account Details Capture
    • APM Countries and Currencies
  • Global Guides
    • Apple Pay
      • Registering with Apple Pay
        • (Manually) Register in the Apple System
          • Create an Apple ID
          • Enroll in the Apple Developer Program
            • Submit an Enrollment Request
            • Complete the Enrollment Process
            • Activate your Apple Developer Program Account
          • Register a Merchant ID in the Apple System
            • Create a Merchant ID
            • Create a Payment Processing Certificate
            • Create a Merchant Identity Certificate
            • Register and Verify Your Domain
      • Nuvei Apple Pay Implementations
        • Payment Page using IFrame
        • Static Apple Pay Button
        • Static Pay Button (Web SDK)
        • Dynamic Apple Pay Button
      • Apple Pay Integration
        • Apple Pay Guide (REST API)
        • Apple Pay Guide (Web SDK)
        • Apple Pay Guide (Checkout)
        • Apple Pay Integration Testing
    • Google Pay
      • Google Pay (REST API)
      • Google Pay (Web SDK)
      • Google Pay (Checkout)
    • Neteller
    • PayPal
    • Skrill
    • Visa Checkout
      • Visa Checkout (REST API)
  • US and Canada Guides
    • ACH
    • Interac Instant
    • Mazooma
    • PayNearMe
    • PlayPlus
      • PlayPlus (REST)
      • PlayPlus (Web SDK)
    • VIP Preferred
      • VIP Preferred (REST)
      • VIP Pref. (Web SDK/Checkout)
  • Europe Guides
    • Aircash
    • Okto Cash
    • Open Banking
  • Latin America Guides
    • LATAM Payouts
    • Pay4Fun
    • PIX
    • PIX Payouts
    • PSE
    • STPmex
  • Asia Pacific Guides
    • Alipay HK
    • Dana
    • DragonPay
    • GCash
    • India Payouts
    • KakaoPay
    • Touch ’n Go
    • TrueMoney

India Payouts

On this page:
  • Introduction
  • Supported Countries
  • Supported Currencies
  • Implementation Details
  • User Experience
  • Testing
  • Appendix
Attributes
  • METHOD TYPEBank Transfer
  • PAYMENT
  • PAYOUT
  • REFUNDS

Introduction

India Payouts supports immediate withdrawals 24 hours per day, 7 days per week in India.

Supported Countries

  • India

Supported Currencies

  • INR

Implementation Details

Click tab to open…

  • for REST API

When performing a /payout with India Payouts, the following flow including the /accountCapture method is used before processing the /payout request:

  1. Send an /accountCapture request that includes the following mandatory fields as shown in the example request below:
    • userTokenId – Unique identifier of the customer in your system
    • paymentMethod: “apmgw_India_Payouts”
    • currencyCode: INR
    • countryCode: IN

      Example /accountCapture Request
      {
        "sessionToken": "<sessionToken from getSessionToken>",
        "merchantId": "<your merchantId>",
        "merchantSiteId": "<your merchantSiteId>",
        "userTokenId": "<unique customer identifier in merchant system>",
        "paymentMethod": "apmgw_India_Payouts",
        "currencyCode": "INR",
        "countryCode": "IN"
      }

      The request returns a redirectUrl.

      Example /accountCapture Response
      {
        "redirectUrl":"https://cdn.safecharge.com/safecharge_resources/v1/bank-details-19624.html?bankAccount=&submitUrl=https%3A%2F%2Ftest.safecharge.com%2FAPMNotificationGateway%2FApmConnector%2FbankCapture%2F78FC9EBD46186B122D5C76C3DAFA963F&mode=1&bankIfsc=&accountNumber=",
        "userTokenId":"Test",
        "sessionToken":"b0c6c219-4428-4c29-b4a7-6d0fda8ba9e8",
        "internalRequestId":464427208,
        "status":"SUCCESS",
        "errCode":0,
        "reason":"",
        "merchantId":"8860255768659021142",
        "merchantSiteId":"119823",
        "version":"1.0"
      }
  2. Use redirectUrl to redirect the customer to the APM’s account details capture interface for them to enter their account details.
  3. Once the information is captured, Nuvei stores the data in a UPO record and sends a DMN back to you with the newly created userPaymentOptionId.
  4. Send a /payout request and include the userPaymentOptionId representing the captured details returned by the /accountCapture request. Press here for an example.


for REST API

When performing a /payout with India Payouts, the following flow including the /accountCapture method is used before processing the /payout request:

  1. Send an /accountCapture request that includes the following mandatory fields as shown in the example request below:
    • userTokenId – Unique identifier of the customer in your system
    • paymentMethod: “apmgw_India_Payouts”
    • currencyCode: INR
    • countryCode: IN

      Example /accountCapture Request
      {
        "sessionToken": "<sessionToken from getSessionToken>",
        "merchantId": "<your merchantId>",
        "merchantSiteId": "<your merchantSiteId>",
        "userTokenId": "<unique customer identifier in merchant system>",
        "paymentMethod": "apmgw_India_Payouts",
        "currencyCode": "INR",
        "countryCode": "IN"
      }

      The request returns a redirectUrl.

      Example /accountCapture Response
      {
        "redirectUrl":"https://cdn.safecharge.com/safecharge_resources/v1/bank-details-19624.html?bankAccount=&submitUrl=https%3A%2F%2Ftest.safecharge.com%2FAPMNotificationGateway%2FApmConnector%2FbankCapture%2F78FC9EBD46186B122D5C76C3DAFA963F&mode=1&bankIfsc=&accountNumber=",
        "userTokenId":"Test",
        "sessionToken":"b0c6c219-4428-4c29-b4a7-6d0fda8ba9e8",
        "internalRequestId":464427208,
        "status":"SUCCESS",
        "errCode":0,
        "reason":"",
        "merchantId":"8860255768659021142",
        "merchantSiteId":"119823",
        "version":"1.0"
      }
  2. Use redirectUrl to redirect the customer to the APM’s account details capture interface for them to enter their account details.
  3. Once the information is captured, Nuvei stores the data in a UPO record and sends a DMN back to you with the newly created userPaymentOptionId.
  4. Send a /payout request and include the userPaymentOptionId representing the captured details returned by the /accountCapture request. Press here for an example.

User Experience

  1. Select the “India_Payouts” method on the cashier.
  2. Enter the amount to withdraw.
    You are redirected to a bank capture page.
  3. Enter the necessary bank details and press Confirm.
    A withdrawal request is created.

Testing

Any test data generates a PENDING transaction.

The payout is either approved automatically or with the help of the provider.

Appendix

The following values are accepted for Bank Name (transactworld_bankAccount):

  • Tamilnad Mercantile Bank
  • Bank Of Maharashtra
  • Central Bank Of India
  • IngVysya Bank
  • State Bank Of Travancore
  • City Union Bank
  • AIRTEL BANK
  • Zoroastrian Bank
  • AU Small Finance Bank
  • ICICI BANK
  • TJSB Bank
  • KOTAK BANK
  • Thane Bharat Sahakari Bank
  • PUNJAB AND MAHARASHTRA COOPERATIVE BANK
  • Karnatka Bank Ltd
  • SBI BANK
  • DHANALAXMI BANK
  • DENA BANK
  • DCB BANK
  • COSMOS Bank
  • FEDERAL BANK
  • Deutsche Bank
  • UCO Bank
  • INDIAN BANK
  • HSBC Bank
  • DEMO Bank
  • PNB Corporate Bank
  • State Bank Of Patiala
  • icici Corporate Bank
  • NKGSB CO-OPERATIVE BANK
  • JANTA SAHAKARI BANK
  • Vijay Bank
  • Allahabad Bank
  • BASSIEN CATHOLIC CO-OPERATIVE BANK
  • Bank Of Bahrain And Kuwait
  • IDFC BANK
  • Oriental Bank Of Commerce
  • Jammu And Kashmir Bank
  • Development Credit Bank
  • BANDHAN BANK
  • THE MEHSANA URBAN CO OP BANK LTD
  • StateBank Of Hyderabad
  • KALYAN JANATA SAHAKARI BANK
  • Union Bank Of India
  • THANE JANATA SAHAKARI BANKÂ LTD
  • State Bank Of Mysore
  • Tamilnadu State Coop Bank
  • SHAMRAO VITHAL COOPERATIVE BANK
  • SARASWAT COOPERATIVE BANK
  • PUNJAB AND SIND BANK
  • Coporation Bank
  • DIGIBANK BY DBS
  • Andhra Bank
  • SHAMRAO VITHAL RETAIL BANK
  • Axis Corporate Bank
  • Canara Bank
  • IndusInd Bank
  • SURYODAY SMALL FINANCE BANK
  • SYNDICATE BANK
  • CitiBank
  • Standard Chartered Bank
  • RATNAKAR BANK CORPORATE
  • Ratnakar Bank
  • Punjab National Bank Corporate Accounts
  • Lakshmi Vilas Bank NetBanking
  • State Bank Of Bikaner And Jaipur
  • Catholic Syrian Bank
  • Bank of Baroda Retail Accounts
  • Bank of Baroda Corporate Accounts
  • Punjab National Bank
  • Laxmi Vilas Bank Corporate Net Banking
  • ESAF SMALL FINANCE BANK
  • Indian Overseas Bank
  • DHANALAXMI BANK CORPORATE
  • AXIS BANK
  • Andhra Corporate Bank
  • HDFC BANK
  • KarurVysya Bank
  • EQUITAS SMALL FINANCE BANK
  • Industrial Development Bank Of India
  • United Bank Of India
  • THE KALUPUR COMMERCIAL COOPERATIVE BANK LIMITED
  • South Indian Bank
  • PNB YUVA BANK
  • YES BANK
  • Bank Of India
2022 Nuvei. All rights reserved.