Skip to main content

4. Transaction Posting

4.1 POST URL: /vpa/paywithvpa/

Request Parameters

#Parameter Name Data Type ConstraintDescription Presence
1requestIdentifierStringLength(20) Request id provided by NPIM
2originatorUniqueIdStringLength(max. 30) Originator unique identifierM
3vpaStringLength(10)Beneficiary identifier (VPA) for fund transferM
4bankId String Length(max. 4) Beneficiary participant code in NCHL systemM
5debtorAgentString Length(max. 4) Debtor bank code in NCHL system M
6debtorBranch StringLength(max.4) Debtor branch code in NCHL systemM
7debtorAccountId StringLength(max. 20) Debtor account numberM
8 debtorName String Debtor account nameM
9 amountBig DecimalTransaction amountM
10remarkStringLength(max. 30) Transaction remarksM
11 tokenString TokenM

Note: For connectIPS based VPA transaction, bank id will be CIPS.

Token String = originatorUniqueId+”,” +requestIdentifier+”,” + bankId+”,” + vpa+”,” +debtorAgent+”,” + debtorBranch+ “,” + debtorAccountId+ “,” + amount+ “,” + userId

Request Parameters

#Parameter Name Data Type ConstraintDescription Presence
1requestIdentifierStringLength(20) Request id provided by NPIM
2originatorUniqueIdStringLength(max. 30) Originator unique identifierM
3vpaStringLength(10)Beneficiary identifier (VPA) for fund transferM
4debitStatusString Length(3) Debit statusM
5creditStatusString Length(3) Credit statusM
6npiBatchIdStringCorresponding batch id for transaction.M
7npiTranactionId String Corresponding transaction id for transaction.M
8token String TokenM

Token String = originatorUniqueId+”,” +requestIdentifier+”,” + vpa+”,” + debitStatus+”,” +npiBatchId+”,” + npiTransactionId+ “,” + userId

Sample Request

{
"requestIdentifier":"2021081**812628Srm",
"originatorUniqueId":" VPA-123456",
"vpa":"9841000000",
"bankId":"2301",
"debtorAgent":"1701",
"debtorBranch":"1",
"debtorAccountId":"1232525252",
"debtorName":"Sparrow SMS",
"amount":200,
"remark":"Test VPA Payment",
"token":"TOKEN
}

Success Response


{
"requestIdentifier": "2021081**812628Srm ",
"originatorUniqueId": " VPA-123456",
"vpa": "9841000000",
"debitStatus": "000",
"creditStatus": "114",
"npiBatchId": "711832",
"npiTransactionId": "1234201",
"token": "TOKEN"
}

Failure Response


{
"responseCode": "400",
"responseDescription": "PARAMETER VALIDATION ERROR",
"fieldErrors": [
{
"field": "vpa",
"message": "VPA should not less than 10-character."
}
]
}