The IMPS API could be used to do a nominal value transaction of Rs 1/- ( referred as Penny drop), which in turn can be used to validate 2 aspects before making payments into the new beneficiary account.
- It fetches the name of the account in the other Bank
- It also gives a confirmation whether the fund transfer to that account will be successful or not (we can rule out a credit-freeze scenario in that account)
Remitter should provide the Account Number and IFSC details of the beneficiary whose account needs to be validated. This API will further initiate the transaction to a beneficiary account with a restricted amount of Rs.1-/ through IMPS Fund Transfer. The beneficiary account holder's name will be returned in the response once the transaction gets succeeded. If in case the transaction fails due to any reason, the API will return an appropriate response along with the reason code.
Saran K Joseph
production
development
https://devgateway.federalbank.co.in/fedbnkdev/dev
Paths
/pennyDrop
post /pennyDrop
Penny Drop API
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/account_utility/pennyDrop
Try this operation
Definitions
IMPS 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. API will validate the uniqueness against the Client and Channel",
"type": "string"
},
"Cust_Ref_No": {
"description": "Conditional Mandatory (you can pass any value which will display in your account statements. If you haven’t passed any value will take reference id value and display in account statement).",
"type": "string"
},
"RemmiterDetails": {
"type": "object",
"description": "Remitter Details",
"properties": {
"Name": {
"description": "Remitter’s Name",
"type": "string"
},
"AccNumber": {
"description": "Remitter’s Account Number. Amount will be debited from this Account.",
"type": "string"
},
"Acctype": {
"description": "Conditional Mandatory (This is Mandatory incase of Acc_Val_Req is’ N’ in database for sender).",
"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"
},
"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"
},
"IFSC": {
"description": "IFSC of the Beneficiary’s home branch",
"type": "string"
},
"Mobile": {
"description": "Beneficiary mobile number. Notifications will be sent to this number.",
"type": "string"
},
"Email": {
"description": "Beneficiary’s e-mail. Notifications will be sent on this Id.",
"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": "Description of the Transaction",
"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",
"Sender_Data"
]
}
Response Structure
{
"type": "object",
"properties": {
"ReferenceId": {
"description": "Alphanumeric. Client should pass unique value to each call, to identify the request. API will validate the uniqueness against the Client and Channel",
"type": "string"
},
"tranTimeStamp": {
"description": "Transaction Timestamp",
"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"
}
}
}
}
}