Dynamic Vpa Resolution
For ReqAuth flow, Juspay system will be initiating the below request to the Merchant system for VPA resolution and based on the response, Juspay will initiate respAuth to NPCI using the incoming request from Merchant.
Request Headers:
Scroll inside to view more
|
Key Name
|
Type
|
Description
|
|---|---|---|
x-merchant-id (M)
| String
| merchant id of the merchant as configured at juspay
|
x-merchant-channel-id (M)
| String
| channel id of the merchant as configured at juspay
|
x-timestamp (M)
| String
| Epoch milliseconds of the request
|
Request Parameters:
Scroll inside to view more
|
Param Name
|
Version
|
Description
|
|---|---|---|
vpa(M)
| V1, V2
| Payee VPA of merchant
|
type("R")(M)
| V1, V2
| “R” for Transaction “V” for Validate VPA
|
payerVpa(M)
| V1, V2
| Payer VPA of customer
|
amount(M)
| V1, V2
| Amount for the transaction. Only sent when type is “R”
|
custRefId(M)
| V1, V2
| custRef received from NPCI. Only sent when type is “R”
|
npciTxnId(M)
| V1, V2
| Txn Id received from NPCI. Only sent when type is “R”
|
purposeCode(M)
| V1, V2
| Purpose received from NPCI. Only sent when type is “R”
|
initiationMode(M)
| V2
| initiationMode received from NPCI. Only sent when type is “R”
|
payerAccType(M)
| V1, V2
| Type of the Payer Account. Only sent when type is “R”
|
orderId(M)
| V1, V2
| orderId for the transaction. Only sent when type is “R”
|
payerIfsc(M)
| V1, V2
| Payer's IFSC
|
payerAccBin(O)
| V1, V2
| Payer's Bank Identification Number
|
payerName(M)
| V2
| Payer's Name
|
payerAccNum(O)
| V2
| Payer's Acc Number
|
payerMaskedAccNum(O)
| V2
| Payer's Masked Acc Number
|
payerMcc(M)
| V2
| Payer's MCC
|
remarks(M)
| V2
| Reference text
|
Response Parameters:
Scroll inside to view more
|
Param Name
|
Type
|
Description
|
|---|---|---|
status(M)
| S or F
| SUCCESS or FAILED
|
responseCode(M)
| 00/ZE/ZH/YG
| Check Npci doc
|
responseMessage(M)
| Alphanumeric
| SUCCESS or FAILED
|
merchantName(M)
| Alphanumeric
| Name of the merchant as received in Penny Drop API/any other account validation mode
|
accountNumber(M)
| Alphanumeric
| Will be required for type "R" only
|
ifsc(M)
| Alphanumeric
| Will be required for type "R" only
|
mcc(M)
| Alphanumeric
| Merchant Category Code
|
txnApproval(M)
| string
| Y - SUCCESS and N - FAILED
|
orderId(M)
| Alphanumeric
| Unique Order ID. Will be provided for type "R" only
|
brandName(M)
| Alphanumeric
| Brand Name of Merchant
|
legalName(M)
| Alphanumeric
| Legal Name of Merchant
|
franchise(M)
| Alphanumeric
| Franchise Details
|
merchantType(M)
| Alpha
| SMALL or LARGE
|
ownershipType(M)
| Alpha
| As per merchant entity type. Values can only be from the following PROPRIETARY | PARTNERSHIP | PRIVATE | PUBLIC | OTHERS
|
genre(M)
| Alpha
| OFFLINE or ONLINE
|
onboardingType(M)
| Alpha
| Aggregator or BANK
|
gstin(O)
| Alphanumeric
| GSTIN of the merchant. For future use
|
payeeAccType(M)
| Alpha
| Account type of the merchant
|
mid(M)
| Alphanumeric
| mid of merchant
|
sid(M)
| Alphanumeric
| sid of merchant
|
tid(M)
| Alphanumeric
| tid of merchant
|
udfParameters(O)
| String
| User defined parameters.Will be sent back in callbacks and status check as sent in request.
|
businessName(O)
| Stringified Json/ Text
| business name of the merchant
|
Sample Response Body:
Note
For initiating the refund and transaction, please refer to the Transactions Module.
For transaction callback please refer to the below link:
https://juspay.io/in/docs/upi-merchant-stack/docs/transactions/collect-callback#Collect-Callback
- Have questions?
- Need help? Contact support
- LLM? Read llms.txt
