Skip to main content

Class ResponsePaymentRequestAPIResponse


Successful Response

NameTYPEREQUIREDDescription
StatusstringYesEnum Values: Accepted, Rejected

ResponseToRequestForPayment.Status
IdstringYesUnique EndToEndId for transaction reference

ResponseToRequestForPayment.Id
AmountnumberDefine the accepted amount on approving the payment request. This is required only when the status is Accepted

ResponseToRequestForPayment.Amount
ReasonCodestringDefine the reason for rejecting the payment request. This is required only when the status is Rejected

ResponseToRequestForPayment.ReasonCode
NotesstringFree text. Any additional information or remarks when sending the payment confirmation.

ResponseToRequestForPayment.Notes
UserNamestringYesDefine the Name of the User Invoking the API

ResponseToRequestForPayment.UserName
OriginalPmtInfIdstringYesDefine the Payment Info Id used to refer the payment request.

ResponseToRequestForPayment.OriginalPmtInfId

Failure Response

NameTYPEREQUIREDDescription
MessagestringYesFree text. Error Message.

ResponseToRequestForPayment.Message
CodestringYesError code

ResponseToRequestForPayment.Error.Code
DescriptionstringYesError description

ResponseToRequestForPayment.Error.Description

Successful Response: JSON representation

{
"ResponseToRequestForPayment": {
"Status": string,
"Id": string,
"OriginalPmtInfId" : string,
"Amount": amount,
"ReasonCode": string,
"Notes": string,
"UserName": string
}
}

Sample Response: Success Scenario

{
"ResponseToRequestForPayment": {
"Status": "Accepted",
"Id": "123456789-RTP-JSHIR7865",
"OriginalPmtInfId": "20211027101010101MTBRHQN00885222784",
"Amount": 87193.07,
"Notes": "Sample Note",
"UserName": "Test User"
}
}

Failure Response: JSON representation

{
"ResponseToRequestForPayment": {
"Message": string,
"Error": {
"Code": string,
"Description": string
}
}
}

Sample Response: Error Scenario

{
"ResponseToRequestForPayment ": {
"Message": "Validation failed",
"Error": {
"Code": "70053",
"Description": "There is no Rfp initiated for receiving Response for Rfp for this payment id - 20211027101010101MTBRHQN00885222785"
}
}
}