API docs by Redocly

Fampay Banking API (1.0.0)

Download OpenAPI specification:

Internal API for managing UPI transactions, bank accounts, and VPA mappings.

Bank Management

List Supported Banks

Fetch a list of all NPCI-supported banks available for linking.

query Parameters
showCreditLines
required
boolean (Showcreditlines)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Account Linking Consent

Retrieve or submit user consent forms required for account aggregation and linking.

Request Body schema: application/json
required
consent_type
string (Consent Type)
Default: "aadhaar"
bank_account_unique_id
required
string (Bank Account Unique Id)

Responses

Request samples

Content type
application/json
{
  • "consent_type": "aadhaar",
  • "bank_account_unique_id": "string"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Set UPI PIN

Initiate the flow to set a new 4 or 6-digit UPI MPIN for a specific bank account.

Request Body schema: application/json
required
type
required
string (Type)
customer_vpa
required
string (Customer Vpa)
bank_account_unique_id
required
string (Bank Account Unique Id)
required
Card Last Six Digits (string) or Card Last Six Digits (null) (Card Last Six Digits)
required
Expiry Month (string) or Expiry Month (null) (Expiry Month)
required
Expiry Year (string) or Expiry Year (null) (Expiry Year)
required
object (Cred Block)
upi_request_id
required
string (Upi Request Id)

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "customer_vpa": "string",
  • "bank_account_unique_id": "string",
  • "card_last_six_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "cred_block": { },
  • "upi_request_id": "string"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Change UPI PIN

Update an existing UPI MPIN by providing the old credentials and new PIN.

Request Body schema: application/json
required
required
object (Cred Block)
customer_vpa
required
string (Customer Vpa)
bank_account_unique_id
required
string (Bank Account Unique Id)
upi_request_id
required
string (Upi Request Id)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "customer_vpa": "string",
  • "bank_account_unique_id": "string",
  • "upi_request_id": "string"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Check Account Balance

Securely retrieve the current balance using an encrypted Credential Block.

Request Body schema: application/json
required
required
object (Cred Block)
customer_vpa
required
string (Customer Vpa)
bank_account_unique_id
required
string (Bank Account Unique Id)
upi_request_id
required
string (Upi Request Id)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "customer_vpa": "string",
  • "bank_account_unique_id": "string",
  • "upi_request_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Unlink Bank Account

Remove a linked bank account from the user's UPI profile.

Request Body schema: application/json
required
bank_account_unique_id
required
string (Bank Account Unique Id)

Responses

Request samples

Content type
application/json
{
  • "bank_account_unique_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Set Default Account

Set the primary bank account for all incoming and outgoing UPI transactions.

Request Body schema: application/json
required
bank_account_unique_id
required
string (Bank Account Unique Id)

Responses

Request samples

Content type
application/json
{
  • "bank_account_unique_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Request Bank OTP

Trigger a bank-generated OTP for sensitive operations like resetting an MPIN.

Request Body schema: application/json
required
required
Type (string) or Type (null) (Type)
required
Customer Vpa (string) or Customer Vpa (null) (Customer Vpa)
required
Bank Account Unique Id (string) or Bank Account Unique Id (null) (Bank Account Unique Id)
required
Card Last Six Digits (string) or Card Last Six Digits (null) (Card Last Six Digits)
required
Expiry Month (string) or Expiry Month (null) (Expiry Month)
required
Expiry Year (string) or Expiry Year (null) (Expiry Year)
required
Aadhaar First Six Digits (string) or Aadhaar First Six Digits (null) (Aadhaar First Six Digits)
required
CredBlockRequestModel (object) or null

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "customer_vpa": "string",
  • "bank_account_unique_id": "string",
  • "card_last_six_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "aadhaar_first_six_digits": "string",
  • "cred_block_dto": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

List Linked Accounts

Retrieve all bank accounts currently linked to the user's profile.

query Parameters
bankCode
required
string (Bankcode)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Add Bank Account

Link a new bank account by discovering accounts associated with the registered mobile number.

Request Body schema: application/json
required
bank_account_unique_id
required
string (Bank Account Unique Id)
not_default
required
string (Not Default)

Responses

Request samples

Content type
application/json
{
  • "bank_account_unique_id": "string",
  • "not_default": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Enable UPI Lite

Onboard the user to UPI Lite for small-value, PIN-less transactions.

Request Body schema: application/json
required
required
object (Cred Block)
bank_account_unique_id
required
string (Bank Account Unique Id)
upi_request_id
required
string (Upi Request Id)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "bank_account_unique_id": "string",
  • "upi_request_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Disable UPI Lite

Deactivate the UPI Lite wallet and refund the remaining balance to the linked bank account.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Sync UPI Lite Balance

Synchronize local on-device wallet balance with the server-side ledger.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

UPI Protocol Versions

Check compatible UPI SDK and protocol versions supported by the backend.

Note: bankCode is equal to --

some: list[str] = [...]

bankCode = ",".join(some[:62])
query Parameters
bankCodes
required
string (Bankcodes)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Collect Requests

Initiate Collect Request

Create a request to pull funds from a third-party VPA.

Request Body schema: application/json
required
init_mode
required
string (Init Mode)
currency
required
string (Currency)
amount
required
string (Amount)
beneficiary_id
required
string (Beneficiary Id)
required
Remarks (string) or Remarks (null) (Remarks)
required
Purpose Code (string) or Purpose Code (null) (Purpose Code)

Responses

Request samples

Content type
application/json
{
  • "init_mode": "string",
  • "currency": "string",
  • "amount": "string",
  • "beneficiary_id": "string",
  • "remarks": "string",
  • "purpose_code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

List Incoming Requests

Fetch all pending collect requests sent to the user.

query Parameters
flow
string (Flow)
Default: "incoming"

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Generate Payment CredBlock

Generate the encrypted payload required to authorize a collect request payment.

Request Body schema: application/json
required
required
Cred Block (object) or Cred Block (null) (Cred Block)
required
Collect Request Id (string) or Collect Request Id (null) (Collect Request Id)
required
Bank Account Unique Id (string) or Bank Account Unique Id (null) (Bank Account Unique Id)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "collect_request_id": "string",
  • "bank_account_unique_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Reject Collect Request

Decline an incoming payment request from another user or merchant.

Request Body schema: application/json
required
collect_request_id
required
string (Collect Request Id)
bank_account_unique_id
required
string (Bank Account Unique Id)

Responses

Request samples

Content type
application/json
{
  • "collect_request_id": "string",
  • "bank_account_unique_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Approve Collect Request

Authorize and execute a collect request payment.

Request Body schema: application/json
required
required
Cred Block (object) or Cred Block (null) (Cred Block)
required
Collect Request Id (string) or Collect Request Id (null) (Collect Request Id)
required
Bank Account Unique Id (string) or Bank Account Unique Id (null) (Bank Account Unique Id)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "collect_request_id": "string",
  • "bank_account_unique_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Get Request Details

Retrieve full metadata for a specific collect request ID.

query Parameters
crId
required
string (Crid)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

VPA Management

Get VPA Suggestions

Generate available custom VPA handles based on user profile data.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Claim Custom VPA

Permanently assign a chosen custom VPA handle to the user profile.

Request Body schema: application/json
required
vpa
required
string (Vpa)

Responses

Request samples

Content type
application/json
{
  • "vpa": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

List User VPAs

Retrieve all Virtual Payment Addresses associated with this user.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Check VPA Status

Check if a custom VPA handle is active or pending verification.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Check VPA Availability

Verify if a specific VPA handle is currently available for registration.

Request Body schema: application/json
required
customer_vpa
required
string (Customer Vpa)

Responses

Request samples

Content type
application/json
{
  • "customer_vpa": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Update Primary VPA

Change which VPA handle is used by default for receiving payments.

Request Body schema: application/json
required
customer_vpa
required
string (Customer Vpa)

Responses

Request samples

Content type
application/json
{
  • "customer_vpa": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

UPI Mandates

List Mandates

Fetch all recurring payment mandates (active, paused, or revoked).

status_filters is comma separated values. valid values --

success,unpaused,processing,failed,declined,revoked,paused,completed,deemed,pending

query Parameters
status_filters
required
string (Status Filters)
page_size
required
integer (Page Size)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Decline Mandate

Reject an incoming request for a recurring payment mandate.

Request Body schema: application/json
required
mandate_id
required
string (Mandate Id)

Responses

Request samples

Content type
application/json
{
  • "mandate_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Generate Mandate CredBlock

Create the encrypted credential block required to sign a mandate setup.

Request Body schema: application/json
required
required
object (Cred Block)
required
Type (string) or Type (null) (Type)
required
Mandate Id (string) or Mandate Id (null) (Mandate Id)
required
Bank Account Unique Id (string) or Bank Account Unique Id (null) (Bank Account Unique Id)
required
Remarks (string) or Remarks (null) (Remarks)
required
Pause End Timestamp (integer) or Pause End Timestamp (null) (Pause End Timestamp)
required
Upi Request Id (string) or Upi Request Id (null) (Upi Request Id)
required
Validity End (integer) or Validity End (null) (Validity End)
required
Amount (string) or Amount (null) (Amount)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "type": "string",
  • "mandate_id": "string",
  • "bank_account_unique_id": "string",
  • "remarks": "string",
  • "pause_end_timestamp": 0,
  • "upi_request_id": "string",
  • "validity_end": 0,
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Authorize Mandate

Sign and activate a recurring payment instruction.

Request Body schema: application/json
required
required
object (Cred Block)
required
Type (string) or Type (null) (Type)
required
Mandate Id (string) or Mandate Id (null) (Mandate Id)
required
Bank Account Unique Id (string) or Bank Account Unique Id (null) (Bank Account Unique Id)
required
Remarks (string) or Remarks (null) (Remarks)
required
Pause End Timestamp (integer) or Pause End Timestamp (null) (Pause End Timestamp)
required
Upi Request Id (string) or Upi Request Id (null) (Upi Request Id)
required
Validity End (integer) or Validity End (null) (Validity End)
required
Amount (string) or Amount (null) (Amount)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "type": "string",
  • "mandate_id": "string",
  • "bank_account_unique_id": "string",
  • "remarks": "string",
  • "pause_end_timestamp": 0,
  • "upi_request_id": "string",
  • "validity_end": 0,
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Pause Mandate

Temporarily stop future payments for an existing mandate.

Request Body schema: application/json
required
required
object (Cred Block)
required
Type (string) or Type (null) (Type)
required
Mandate Id (string) or Mandate Id (null) (Mandate Id)
required
Bank Account Unique Id (string) or Bank Account Unique Id (null) (Bank Account Unique Id)
required
Remarks (string) or Remarks (null) (Remarks)
required
Pause End Timestamp (integer) or Pause End Timestamp (null) (Pause End Timestamp)
required
Upi Request Id (string) or Upi Request Id (null) (Upi Request Id)
required
Validity End (integer) or Validity End (null) (Validity End)
required
Amount (string) or Amount (null) (Amount)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "type": "string",
  • "mandate_id": "string",
  • "bank_account_unique_id": "string",
  • "remarks": "string",
  • "pause_end_timestamp": 0,
  • "upi_request_id": "string",
  • "validity_end": 0,
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Resume Mandate

Re-enable a previously paused recurring payment mandate.

Request Body schema: application/json
required
required
object (Cred Block)
required
Type (string) or Type (null) (Type)
required
Mandate Id (string) or Mandate Id (null) (Mandate Id)
required
Bank Account Unique Id (string) or Bank Account Unique Id (null) (Bank Account Unique Id)
required
Remarks (string) or Remarks (null) (Remarks)
required
Pause End Timestamp (integer) or Pause End Timestamp (null) (Pause End Timestamp)
required
Upi Request Id (string) or Upi Request Id (null) (Upi Request Id)
required
Validity End (integer) or Validity End (null) (Validity End)
required
Amount (string) or Amount (null) (Amount)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "type": "string",
  • "mandate_id": "string",
  • "bank_account_unique_id": "string",
  • "remarks": "string",
  • "pause_end_timestamp": 0,
  • "upi_request_id": "string",
  • "validity_end": 0,
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Cancel Mandate

Permanently terminate a mandate instruction.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Modify Mandate

Update mandate details like validity period or maximum transaction amount.

Request Body schema: application/json
required
required
object (Cred Block)
required
Type (string) or Type (null) (Type)
required
Mandate Id (string) or Mandate Id (null) (Mandate Id)
required
Bank Account Unique Id (string) or Bank Account Unique Id (null) (Bank Account Unique Id)
required
Remarks (string) or Remarks (null) (Remarks)
required
Pause End Timestamp (integer) or Pause End Timestamp (null) (Pause End Timestamp)
required
Upi Request Id (string) or Upi Request Id (null) (Upi Request Id)
required
Validity End (integer) or Validity End (null) (Validity End)
required
Amount (string) or Amount (null) (Amount)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "type": "string",
  • "mandate_id": "string",
  • "bank_account_unique_id": "string",
  • "remarks": "string",
  • "pause_end_timestamp": 0,
  • "upi_request_id": "string",
  • "validity_end": 0,
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Initialize Mandate Payment

Create a transaction intent for a specific mandate installment.

Request Body schema: application/json
required
amount
required
string (Amount)
amount_rule
required
string (Amount Rule)
initiation_mode
required
string (Initiation Mode)
required
Mandate Name (string) or Mandate Name (null) (Mandate Name)
mandate_type
required
string (Mandate Type)
payee_vpa
required
string (Payee Vpa)
required
Purpose Code (string) or Purpose Code (null) (Purpose Code)
recurrence_rule
required
string (Recurrence Rule)
recurrence_pattern
required
string (Recurrence Pattern)
status
string (Status)
Default: "initiated"
upi_request_id
required
string (Upi Request Id)
validity_end
required
integer (Validity End)
required
Validity Start (integer) or Validity Start (null) (Validity Start)
bank_account_unique_id
required
string (Bank Account Unique Id)
mcc
required
string (Mcc)
remarks
required
string (Remarks)
required
Recurrence Value (string) or Recurrence Value (null) (Recurrence Value)
ref_url
required
string (Ref Url)
transaction_reference
required
string (Transaction Reference)
recipient_name
required
string (Recipient Name)
payer_revocable
required
boolean (Payer Revocable)

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "amount_rule": "string",
  • "initiation_mode": "string",
  • "mandate_name": "string",
  • "mandate_type": "string",
  • "payee_vpa": "string",
  • "purpose_code": "string",
  • "recurrence_rule": "string",
  • "recurrence_pattern": "string",
  • "status": "initiated",
  • "upi_request_id": "string",
  • "validity_end": 0,
  • "validity_start": 0,
  • "bank_account_unique_id": "string",
  • "mcc": "string",
  • "remarks": "string",
  • "recurrence_value": "string",
  • "ref_url": "string",
  • "transaction_reference": "string",
  • "recipient_name": "string",
  • "payer_revocable": true
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Finalize Mandate Payment

Submit the mandate transaction to the NPCI switch for execution.

Request Body schema: application/json
required
required
object (Cred Block)
mandate_id
required
string (Mandate Id)

Responses

Request samples

Content type
application/json
{
  • "cred_block": { },
  • "mandate_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

Get Mandate Details

Retrieve detailed configuration for a specific mandate.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Mandate Txn History

List all transactions processed under a specific mandate ID.

query Parameters
mandate_id
required
string (Mandate Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "code": "string",
  • "message": "string"
}

UPI Mapper

List Mapped Numbers

Retrieve mobile-to-VPA mappings stored in the central UPI mapper.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Create Mapper Entry

Map a mobile number or UPI number to a specific VPA.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Update Mapper

Change the destination VPA for a currently mapped mobile number.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Check UPI Number

Check if a numeric UPI ID is available for registration.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Transactions

Transaction History

Fetch the global transaction history for the user profile.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Initialize Payment

Create an intent for a new peer-to-peer or peer-to-merchant payment.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Execute Payment

Submit an authorized transaction to the bank for final settlement.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Report User

Block a VPA and report it as a spam/fraudulent account to NPCI.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Dispute Management

Raise Dispute

Initiate a UDIR (Unified Dispute and Issue Resolution) complaint for a failed transaction.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Check Dispute Status

Track the progress of an active UDIR dispute case.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Delegate Accounts

Delegate CredBlock

Generate credentials for a delegate user to sign a payment.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Get Delegate Requests

Fetch all payment requests waiting for parent approval.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Parent Approval

Authorize a payment request initiated by a delegate account.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Parent Decline

Reject a payment request initiated by a delegate account.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

User & Security

Get Auth Session

Retrieve a fresh authentication session for the native UPI SDK.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

User Account Info

Fetch general user profile metadata and registration status.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Initiate Device Binding

Start the SIM binding process by generating a unique challenge for SMS verification.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Verify Device Binding

Confirm the SMS challenge to cryptographically bind the device to the user account.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Fetch NPCI Token

Retrieve the short-lived security token required for NPCI common library interactions.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

De-register UPI

Permanently wipe the UPI profile and device bindings for this user.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

Global CredBlock

Generate a generic credential block for miscellaneous secure operations.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

VPA Verification

Verify VPA

Perform a real-time check against the NPCI mapper to fetch the name of a VPA owner.

Request Body schema: application/json
required
required
Upi Number (string) or Upi Number (null) (Upi Number)
required
Bank Account Number (string) or Bank Account Number (null) (Bank Account Number)
required
Ifsc (string) or Ifsc (null) (Ifsc)
required
Upi String (string) or Upi String (null) (Upi String)
required
Bharat Qr (string) or Bharat Qr (null) (Bharat Qr)

Responses

Request samples

Content type
application/json
{
  • "upi_number": "string",
  • "bank_account_number": "string",
  • "ifsc": "string",
  • "upi_string": "string",
  • "bharat_qr": "string"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}

External VPA Verification

Extended verification for cross-PSP VPA handles.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "code": "string",
  • "message": "string"
}