API Overview

Recent Revisions to This Document

About This Guide

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Overview of RuPay Payer Authentication
- Authentication Modes

Redirection Mode Payer Authentication
- Check Enrollment Service
  - Check Enrollment Request
  - pa-rupay-int-redir-enroll-overview-resp
  - REST Example: Enrollment Service
- Authenticating Cards Using Redirection
  - HTML Frame Requirements
  - HTTP Post Form
  - PARes Message from the RuPay Card-Issuing Bank
- Authorization Service
  - REST Example: Authorization
- Validating Authentication
  - Validation Service Request
  - Pass or Fail Message Page
  - REST Example: Validate Authentication Service

Seamless Flow Payer Authentication
- Possible Authentication Results
- One-Time Password Generation
  - Required Fields for Generating a One-Time Password in RuPay
  - REST Example: One-Time Password Generation
  - REST Example: One-Time Password Generation (with Token)
- One-Time Password Resend
  - Required Field for Resending a One-Time Password in RuPay
  - Response Field for Checking Enrollment in Payer Authentication
  - REST Example: One-Time Password Resend
  - REST Example: One-Time Password Resend (with Token)
- One-Time Password Validation
  - Required Fields for Validating a One-Time Password in RuPay
  - Response Fields for Payer Authentication Validation in RuPay
  - Example: One-Time Password Validation (No Token)

Standing Instructions
- Standing Instruction Registration
  - Required Fields for Standing Instruction Registration
  - Optional Fields for Standing Instruction Registration
  - REST Example: Registering a Standing Instruction
  - REST Example: Registering a Standing Instruction (with Token)
- Standing Instruction Modification
  - Required Fields for Standing Instruction Modification
  - Optional Fields for Standing Instruction Modification
  - REST Example: Modifying a Standing Instruction
  - REST Example: Modifying a Standing Instruction (with Token)
- Standing Instruction Deregistration (Cancellation)
  - Required Fields for Deregistering a Standing Instruction
  - REST Example: Deregistering a Standing Instruction
  - REST Example: Deregistering a Standing Instruction (with Token)
- Completion of Standing Instructions
  - Required Fields for Standing Instruction Completion
  - REST Example: Completing a Standing Instruction
- Standing Instructions Intimation
  - Required Fields
  - REST Example: Intimating a Standing Instruction
- One-Time Password Generation
  - Required Fields for Generating a One-Time Password in RuPay
  - Optional Fields for Generating a One-Time Password
  - REST Example: One-Time Password Generation
  - REST Example: One-Time Password Generation (with Token)
- One-Time Password Resend
  - REST Example: One-Time Password Resend
  - REST Example: One-Time Password Resend (with Token)
- One-Time Password Validation
  - Required Fields for Validating a One-Time Password in RuPay
  - Response Fields for Payer Authentication Validation in RuPay
  - Example: One-Time Password Validation (No Token)
- Standing Instruction Authorization
  - Required Fields for SI Authorizations
  - Optional Fields for Standing Instruction Authorization
  - REST Example: Authorizing a Standing Instruction
  - REST Example: Authorization of a Standing Instruction Transaction (with Token)

On This Page

REST Example: Registering a Standing Instruction

Request

{
   "clientReferenceInformation":{
       "code":"test"
   },
   "orderInformation":{
       "billTo":{
       "firstName":"Suman",
       "lastName":"Kumar",
       "address1":"Bagmane WTC",
       "address2":"Doddenakundi",
       "locality":"Bangalore",
       "country":"IN",
       "administrativeArea":"KA",
       "postalCode":"560048",
       "email":"test@domain.com",
       "phoneNumber":"7606160717"
    },
    "amountDetails":{
        "totalAmount":"100.00",
        "currency":"INR"
    }
},
    "paymentInformation":{
        "card":{
            "type":"061",
            "expirationMonth":"12",
            "expirationYear":"2025",
            "number":"5082301226408XXXX",
            "securityCode" :"123"
        }
     },
     "deviceInformation" :{
         "httpAcceptBrowserValue" : "accept",
         "userAgentBrowserValue" : "user",
         "ipAddress":"10.0.0.1"
     },
     "installmentInformation": {
         "paymentType": "1",
         "firstInstallmentDate": "01012023",
         "lastInstallmentDate": "01012024",
         "totalCount": "12",
         "minAmount" :"10",
         "maxAmount" :"100",
         "preferredDay":"05",
         "frequency": "1",
         "alertPreference":"SMS",
         "sequence": "2"
     },
}

Successful Response

{
    "clientReferenceInformation": {
         "code": "test"
    },
"consumerAuthenticationInformation": {
     "validityPeriod": "05",
     "authenticationTransactionContext": "100000000000000000000000025253",
     "authenticationTransactionId": "00000012345334130405260122",
     "veresEnrolled": "Y",
     "authenticationPath": "ENROLLED",
     "authenticationType": "20",
     "specificationVersion": "rupay",
     "token": "AxjzbwSTWgAKsBvnFT5i/989TSoGg2p6yDpxAU1Xb2/+xcVYlDjA/AAABgHI"
},
"errorInformation": {
     "reason": "CONSUMER_AUTHENTICATION_REQUIRED",
     "message": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction."
},
"id": "6382576457887159500386",
"status": "PENDING_AUTHENTICATION",
"submitTimeUtc": "2023-11-30T07:34:06Z"
}

Back to top