Method: users.validateRegistration

Stay organized with collections Save and categorize content based on your preferences.

Validates a previously initiated registration request for a customer's bank account with UPI on the issuer bank. Either a customer reference (such as a resident id, like Aadhaar or a mobile phone number) must be specified, or a bank account reference must be provided.

The following security details must be validated by the bank adapter service with the bank's backend systems:

  1. Debit card details
  2. ATM PIN
  3. SMS OTP

This API should return a 400 HTTP status code if it is unable to process the request. The reason field in the ErrorInfo response should contain one of the following values:

  • ACCT_BLOCKED = Account is blocked.

  • ACCT_DORMANT = Account is dormant.

  • ACCT_FROZEN = Account is frozen.

  • ACCT_INACTIVE = Account is inactive.

  • ACCT_NOT_FOUND = Account not found in the bank's systems.

  • CARD_MANAGEMENT_SYSTEM_FAILURE = Bank card management system is down.

  • INACTIVE_DEBIT_CARD = Debit card is inactive.

  • INCORRECT_ATM_PIN = Incorrect ATM pin.

  • INCORRECT_OTP = OTP provided is incorrect.

  • INVALID_DEBIT_CARD = Debit card details provided are invalid.

  • EXPIRED_DEBIT_CARD = Debit card is expired.

  • MOBILE_NUMBER_MULTIPLE_CUSTOMERS = Mobile number is linked with multiple customers.

  • OTP_EXPIRED = Specified OTP has expired.

  • RESTRICTED_DEBIT_CARD = Debit card is restricted.

Note: This API will be invoked in the UPI ReqRegMob API flow.

HTTP request

POST https://issuer-bank-adapter.your-domain.com/v1/users:validateRegistration

Request body

The request body contains data with the following structure:

JSON representation
{
  "debitCardInfo": {
    object (DebitCardInfo)
  },
  "atmPin": string,
  "otp": string,
  "participant": {
    object (Participant)
  },

  // Union field reference can be only one of the following:
  "customerReference": {
    object (CustomerReference)
  },
  "accountReference": {
    object (AccountReference)
  }
  // End of list of possible types for union field reference.
}
Fields
debitCardInfo

object (DebitCardInfo)

Information about a customer's debit card that needs to be validated by the bank.

atmPin

string

The ATM pin for the debit card that needs to be validated by the bank.

otp

string

The OTP received on the customer's mobile phone that needs to be validated by the bank.

participant

object (Participant)

Participant validating the registration.

Union field reference. Identifies the customer or bank account whose registration for UPI is to be validated. Either a customer reference or a bank account reference will be provided. Only one of the two will be specified. reference can be only one of the following:
customerReference

object (CustomerReference)

The combination of a reference type and reference number that uniquely identifies a bank customer. This field will be used if the customer is identified based on a unique resident identifier (like Aadhaar) or based on the customer's mobile number.

accountReference

object (AccountReference)

A reference to uniquely identify a customer's bank account based on India's UPI standards.

Response body

If successful, the response body is empty.