Real-Time Gross Settlement (RTGS) is a fund transfer system maintained by the RBI, which enables fund transfer from one bank to another, on a real-time and gross basis. The real-time settlement means transactions are settled as soon as they are processed. The transactions are settled on a one-to-one basis, which means the system will not club or bundle a transaction with another. This is one of the fastest possible ways to transfer money, between Banks in India. RTGS is a better option for high-value transactions, that need immediate clearing. The RTGS service window for customer transactions is available to banks from 7 AM to 6 PM on a working day, for settlement at the RBI end. However, the timings that the banks follow may vary depending on the customer timings of the bank branches. The RTGS Fund Transfer API accepts the Remitter’s Name, Account Number, Mobile Number, etc. and the Beneficiary’s Account Number, Mobile Number and IFSC of the Beneficiary Bank’s branch in the request payload message. If the RTGS request is received after the cut-off time, the system will try the NEFT channel. If the NEFT cut-off time has expired, the request will be parked and will be attempted during the next working day. Requests cannot be cancelled. This API will first respond with an Acknowledgement message immediately, which will contain the UTR, the unique transaction reference number provided by the Bank. When the transaction completes, the final transaction status message will be returned. This final message will have details of the fund transfer status, remitter’s and beneficiary’s account, the amount transferred, etc. Based on the status code, RESPONSE_CODE, and description, the client application can take appropriate actions. Both the response messages will have the same ReferenceID, with which the client had invoked this API.
Paths
/fundtransfer
Fund Transfer for RTGS
Requst payload
200 OK
Bad Request - Operation Error
Internal Server Error
Definitions
RTGS Request
{
"type": "object",
"properties": {
"respUrl": {
"description": "Response / Call back URL. API will send the response back to this URL, provided by the client.",
"type": "string"
},
"userid": {
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production",
"type": "string"
},
"password": {
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production",
"type": "string"
},
"sendercd": {
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production",
"type": "string"
},
"tranDate": {
"description": "Date should be in this format “DD-MM-YYYY”. API does not validate this date.",
"type": "string"
},
"ReferenceId": {
"description": "Alphanumeric. Client should pass unique value to each call, to identify the request",
"type": "string"
},
"debitAccountNumber": {
"description": "Account Number to which the fund needs to be Credited, in case the Fund transfer fails at the Credit Leg.",
"type": "string"
},
"debitSuspenseAccount": {
"description": "Flag indicating to use the Debit Account, mentioned in the above field.",
"type": "string"
},
"RemmiterDetails": {
"type": "object",
"description": "Remitter Details",
"properties": {
"Name": {
"description": "Remitter’s Name",
"type": "string"
},
"AccNumber": {
"description": "Amount will be debited from this Account.",
"type": "string"
},
"Mobile": {
"description": "Remitter’s mobile. Notifications will be sent to this mobile.",
"type": "string"
},
"Email": {
"description": "Remitter’s e-mail. Notifications will be sent to this mobile.",
"type": "string"
},
"address": {
"description": "Remitter’s address",
"type": "string"
},
"Notification_Flag": {
"description": "(BOTH, EMAIL, NONE, SMS)‘BOTH’: Email and SMS Notifications will be sent to customer’s mobile and email id.‘EMAIL’: Only Email Notification will be sent to customer’s email Id.‘SMS’: Only SMS Notification will be sent to customer’s mobile.‘NONE’: No notification will be sent.",
"type": "string"
}
}
},
"BeneficiaryDetails": {
"type": "object",
"description": "Beneficiary Details",
"properties": {
"Name": {
"description": "Beneficiary Name",
"type": "string"
},
"AccNumber": {
"description": "Beneficiary Account Number",
"type": "string"
},
"Acctype": {
"description": "Beneficiary Account Type",
"type": "string"
},
"IFSC": {
"description": "IFSC of the Beneficiary’s home branch.",
"type": "string"
},
"Mobile": {
"description": "Beneficiary mobile. Notifications will be sent to this mobile.",
"type": "string"
},
"Email": {
"description": "Beneficiary e-mail. Notifications will be sent to this mobile.",
"type": "string"
},
"address": {
"description": "Beneficiary address.",
"type": "string"
},
"Notification_Flag": {
"description": "(BOTH, EMAIL, NONE, SMS)‘BOTH’: Email and SMS Notifications will be sent to customer’s mobile and email id.‘EMAIL’: Only Email Notification will be sent to customer’s email Id.‘SMS’: Only SMS Notification will be sent to customer’s mobile.‘NONE’: No notification will be sent.",
"type": "string"
}
}
},
"Amount": {
"description": "Amount to be Transferred",
"type": "number"
},
"Remarks": {
"description": "Transaction remarks.",
"type": "string"
},
"Alternative_Payments": {
"description": "Not used. Pass ‘N’",
"type": "string"
},
"Sender_Data": {
"description": "Additional transaction details, if any. Eg. bifurcation of the Transaction Amount into its constituent heads. This will be included as part of the e-mail notification sent to the Beneficiary.",
"type": "string"
}
},
"required": [
"respUrl",
"userid",
"password",
"sendercd",
"tranDate",
"ReferenceId",
"RemmiterDetails",
"BeneficiaryDetails",
"Amount",
"Remarks",
"Alternative_Payments",
"Sender_Data"
]
}
Response Structure
{
"type": "object",
"properties": {
"ReferenceId": {
"description": "Alphanumeric. Client should pass unique value to each call, to identify the request",
"type": "string"
},
"tranTimeStamp": {
"description": "Transaction Timestamp",
"type": "string"
},
"UTR": {
"description": "UTR",
"type": "string"
},
"responseCode": {
"description": "Response Code for the Transaction",
"type": "string"
},
"reason": {
"description": "Response Description for the Transaction",
"type": "string"
}
}
}
error Response Structure
{
"type": "object",
"properties": {
"errorResponse": {
"type": "object",
"properties": {
"tranTimeStamp": {
"type": "string",
"description": "Server Timestamp of the transaction"
},
"statuscode": {
"type": "string",
"description": "HTTP Status Code of the Transaction"
},
"statusreason": {
"type": "string",
"description": "HTTP status reasonphrase of the transaction"
},
"customcode": {
"type": "string",
"description": "custom reference code of the status of the transaction."
},
"customreason": {
"type": "string",
"description": "short description of the result of the transaction"
},
"tranId": {
"type": "string",
"description": "Server Transaction Id"
},
"description": {
"type": "string",
"description": "description of the error"
},
"additionalDetails": {
"type": "object",
"description": "further details related to the transaction"
}
}
}
}
}