4. Transaction Posting
4.1 POST URL: /vpa/paywithvpa/
Request Parameters
# | Parameter Name | Data Type | Constraint | Description | Presence |
---|---|---|---|---|---|
1 | requestIdentifier | String | Length(20) | Request id provided by NPI | M |
2 | originatorUniqueId | String | Length(max. 30) | Originator unique identifier | M |
3 | vpa | String | Length(10) | Beneficiary identifier (VPA) for fund transfer | M |
4 | bankId | String | Length(max. 4) | Beneficiary participant code in NCHL system | M |
5 | debtorAgent | String | Length(max. 4) | Debtor bank code in NCHL system | M |
6 | debtorBranch | String | Length(max.4) | Debtor branch code in NCHL system | M |
7 | debtorAccountId | String | Length(max. 20) | Debtor account number | M |
8 | debtorName | String | Debtor account name | M | |
9 | amount | Big Decimal | Transaction amount | M | |
10 | remark | String | Length(max. 30) | Transaction remarks | M |
11 | token | String | Token | M |
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 | Constraint | Description | Presence |
---|---|---|---|---|---|
1 | requestIdentifier | String | Length(20) | Request id provided by NPI | M |
2 | originatorUniqueId | String | Length(max. 30) | Originator unique identifier | M |
3 | vpa | String | Length(10) | Beneficiary identifier (VPA) for fund transfer | M |
4 | debitStatus | String | Length(3) | Debit status | M |
5 | creditStatus | String | Length(3) | Credit status | M |
6 | npiBatchId | String | Corresponding batch id for transaction. | M | |
7 | npiTranactionId | String | Corresponding transaction id for transaction. | M | |
8 | token | String | Token | M |
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."
}
]
}