Request For Payment Inbound
The InBoundRequestForPayment method enables to process the Payment Request (RFP_IN) received from the beneficiary.
Method: InboundServiceClient:InBound RequestForPayment
Headers
Name | Value |
---|---|
Credential | "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5" |
Signature | "{{signature}}" |
Example
Payload Parameters
Parameter | Description |
---|---|
amount Mandatory | Object |
amount Mandatory | Number Amount of transaction Example – 1122 |
currency Mandatory | String Currency code in which the transaction happens Example – "USD" |
creditorAccount Mandatory | Object |
accountNumber Mandatory | String Account number of the sender Example – "6464656646" |
memberId Mandatory | String Routing numer of the sender bank/financial institution Example – "111412868" |
name Mandatory | String Name of the sender Example – "Akash" |
debtorAccount Mandatory | Object |
accountNumber Mandatory | String Account number of the receiver Example – "417485828882" |
memberId Mandatory | String Routing numer of the receiver bank/financial institution Example – "101115315" |
name Mandatory | String Name of the receiver Example – "Sidhu" |
instrumentProp Mandatory (Applicable only for TCH) | String Proprietary code of Instant payment Example – "STANDARD" |
msgID Mandatory | String Unique message identifier to identify the pacs.008 message Example – "M20231026101115315T1BTST66024532389" |
paymentInfo Mandatory | Object |
endToEndID Mandatory | String ID that enables to trace the transaction at any time during the process Example – "3456956446787686189" |
expireDate Mandatory | String Expiry date of the payment request Example – "2023-10-27" |
paymentId Mandatory | String Payment reference ID of the transaction Example – "20231026101115315T1BTTST66024532389" |
reqDate Mandatory (Applicable only for FedNow) | String Date of payment requested by the originator Example – "2024-04-01" |
paymentMethod Mandatory (Applicable only for TCH) | String Means of payment used to move the amount Example – "TRF" |
processor Mandatory | String Payment channel through which the transaction happens Example – "TCH" or "FedNow" |
referenceNumber Mandatory | String Reference number of the transaction Example – "M20231026101115315T1BTST66024532389" |
SenderType Mandatory (Applicable only for TCH) | String Type of customer Example – "CONSUMER" |
uuid Mandatory | String Unique ID present in the message Example – "331bc65f-f316-47f5-bd23-345265b64a5e" |
Request Body (Applicable for both FedNow and TCH)
{
"amount": {
"amount": 1122,
"currency": "USD"
},
"creditorAccount": {
"accountNumber": "6464656646",
"memberId": "111412868",
"name": "Akash"
},
"debtorAccount": {
"accountNumber": "417485828882",
"memberId": "101115315",
"name": "Sidhu"
},
"instrumentProp": "STANDARD", //applicable only for TCH
"msgID": "M20231026101115315T1BTST66024532389",
"paymentInfo": {
"endToEndID": "3456956446787686189",
"expireDate": "2023-10-27",
"paymentId": "20231026101115315T1BTTST66024532389",
"reqDate": "2024-04-01", //applicable only for FedNow
"paymentMethod": "TRF" //applicable only for TCH
},
"processor": "TCH",
"referenceNumber": "M20231026101115315T1BTST66024532389",
"senderType": "CONSUMER", //applicable only for TCH
"uuid": "331bc65f-f316-47f5-bd23-345265b64a5e"
}
Response
Response Parameters
Parameter | Description |
---|---|
referenceNumber | String Reference number of the transaction Example – "M20231026101115315T1BTST66024532389" |
reason | String Reason code for rejection Example – "AC02" |
status | String Status of the transaction Example – "RCVD" |
Response Body (Applicable for both FedNow and TCH)
//Response for Status "Accepted"
{
"referenceNumber": "M20231026101115315T1BTST66024532389",
"status": "RCVD"
}
//Response for Status "Rejected"
{
"reason": "AC02",
"referenceNumber": "M20231026101115315T1BTST73962932389",
"status": "RJCT”
}