This Service is used for transferring the money to a bank account across any banks in India via UPI Channel using UPI VPA (Virtual Payment Address).
API Support
production
development
https://devgateway.federalbank.co.in/fedbnkdev/dev
Paths
/pay_req
post /pay_req
appSecret
X-IBM-Client-Secret
(apiKey located in header)
appId
X-IBM-Client-Id
(apiKey located in header)
req
Required in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
Example Request
Example Response
POST https://devgateway.federalbank.co.in/fedbnkdev/dev/fundtransfer/pay_req
Try this operation
Definitions
{
"type": "object",
"properties": {
"respUrl": {
"type": "string",
"description": "The client application must provide this URL to which API will return the final validation response. E.g. “http://test.company.com:443/upi-response”"
},
"userid": {
"type": "string",
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production"
},
"password": {
"type": "string",
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production"
},
"sendercd": {
"type": "string",
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production"
},
"tranDate": {
"type": "string",
"description": "Date on which this transaction is initiated, in “DD-MM-YYYY” format. E.g. “12-06-2019”"
},
"tranType": {
"type": "string",
"description": "Transaction Type"
},
"ReferenceId": {
"type": "string",
"description": "Client should pass unique value to each call, to identify the request. API will return the same ReferenceId in all response messages, to enable the client to link the response to the request. E.g. “UPI0820171601319”"
},
"CustomerReferenceId": {
"type": "string",
"description": "Reference Id related to the Customer. E.g “082261700006”"
},
"RemmiterDetails": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Remitter’s Name. E.g. “ACME Corporation”"
},
"VirtualId": {
"type": "string",
"description": "UPI Virtual ID of the Remitter. E.g. “mobilerc@fede”"
},
"AccNumber": {
"type": "string",
"description": "Bank Account Number of the Remitter. E.g. “99980100068100”"
},
"IFSC": {
"type": "string",
"description": "IFSC of the Remitters Bank. E.g. “FDRL0001001”"
},
"Mobile": {
"type": "string",
"description": "Mobile Number of the Remitter. Required for SMS Notifications. E.g. “7702728365”. Country Code is not required. ‘+91’ is default."
},
"Email": {
"type": "string",
"description": "Email Id of the Remitter. E.g. “remit@test.co.in”"
},
"Notification_Flag": {
"type": "string",
"description": "Notification Flag. Possible values are: ‘BOTH’ - Email and SMS Notification will be sent to Remitter’s mobile and email id ‘EMAIL’ - only Email notification will be sent to Remitter’s email id ‘SMS’ - only SMS notification will be sent to Remitter’s mobile NONE - No notification will be sent."
}
}
},
"BeneficiaryDetails": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Beneficiary Name. E.g. “Corporation”"
},
"VirtualId": {
"type": "string",
"description": "UPI Virtual Id of the Beneficiary. E.g. “bankingapi@fede”"
},
"AccNumber": {
"type": "string",
"description": "Beneficiary Account Number"
},
"IFSC": {
"type": "string",
"description": "IFSC of the Beneficiary Account"
},
"Mobile": {
"type": "string",
"description": "Mobile Number of the Beneficiary. Required for SMS Notifications. E.g. “7702728333”. Country Code is not required. ‘+91’ is default."
},
"MMID": {
"type": "string",
"description": "Mobile Money Identifier. E.g. “9049100”"
},
"Aadhaar": {
"type": "string",
"description": "Aadhaar Number of the Beneficiary. E.g. “802220547259”"
},
"Email": {
"type": "string",
"description": "Email id of the beneficiary. E.g. “benefic@test.co.in”"
},
"Notification_Flag": {
"type": "string",
"description": "Notification Flag. Possible values are: ‘BOTH’ - Email and SMS Notification will be sent to Beneficiary’s mobile and email id ‘EMAIL’ - only Email notification will be sent to Beneficiary’s email id ‘SMS’ - only SMS notification will be sent to Beneficiary’s mobile NONE - No notification will be sent."
}
}
},
"Amount": {
"type": "number",
"description": "Amount to be transferred. E.g. “199899.00”"
},
"Remarks": {
"type": "string",
"description": "Remarks to be captured against this transaction. E.g. “For paying bill.”"
},
"Sender_Data": {
"type": "string",
"description": "Additional remarks to be captured against this transaction. E.g. “Sending money, for paying bill.”"
}
}
}
{
"type": "object",
"properties": {
"ReferenceId": {
"type": "string",
"description": "The ReferenceId which the client application provided in the input message. API will return the same ReferenceId. E.g. “federal000130”"
},
"CustomerReferenceId": {
"type": "string",
"description": "The CustomerReferenceId which the client application provided in the input message. API will return the same CustomerReferenceId. E.g. “082261700006”"
},
"TransactionId": {
"type": "string",
"description": "Unique Id which the API has assigned to this transaction. E.g. “FDRad4ce0785064493bb9af715bd3e4f7f6”"
},
"tranTimeStamp": {
"type": "string",
"description": "The timestamp at which the server received this request. E.g. “2018-11-29 15:43:10.636504”"
},
"responseCode": {
"type": "string",
"description": "The acknowledgement response code. “00” for Success."
},
"reason": {
"type": "string",
"description": "The description for the response code. E.g. “RECEIVED SUCCESSFULLY”."
}
}
}
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"
}
}
}
}
}