Forum Topics Posts Last post
Get help and advice on the use of our APIs.
The API is used for checking the aadhar mobile match.
0 0 n/a
This API is used to create an Account with the Bank and generate an Account Number for the customer. After receiving success acknowledge you have to call Account creation enquiry API for getting the status of the request
0 0 n/a
0 0 n/a
This method enables an AA to discover accounts belonging to a Customer based on the customer identifiers. A list of masked account information and corresponding linkRefNumber for each discovered account are returned based on identifier matching logic at FIP.
0 0 n/a
This API is used to enquire the Account details of the Federal Bank customer based on the Account Number provided in the input. It reveals the details like Customer Name, Account Type, Account Status and Balance of the customer.
0 0 n/a
This API is used to enquire the Account details of the Federal Bank customer based on the Account Number provided in the input. It reveals the details like Customer Name, Account Type, and Account Status of the customer.
0 0 n/a
This API can be used to retrieve the details of the given Bank Account along with the list of transactions, on any given date. API accepts the account number and transaction date as input, along with other parameters. Account Statement API will validate the values provided in sender_cd, account_num and date fields. This API returns maximum of 200…
 0 0 n/a
This Service is useful for linking the customer's existing account with the customer Device (Device Token and Profile Id) and Mobile Number. After receiving the request, the Neo banking application will validate the given account number. If the account number is valid and exists in the CBS, an OTP gets triggered to the registered mobile number. Client…
 0 0 n/a
Using the Account Status Enquiry API, a client application can fetch the account status from CBS through back end using account number, mobile number, request channel, request ID, etc. The account status includes details like account close flag, account freeze flag, kyc flag, lien marking, etc.
0 0 n/a
The Device listing service offers 2 APIS. The "Deactivate/Activate Device" API helps to deactivate a device( which was earlier whitelisted at Bank's end), in case there is no use of that particular device any longer. The same service can also used for activating the device which was earlier deactivated.
0 0 n/a
The Device listing service offers 2 APIS. The "Add device" API , helps to whitelist a device for the first time at Bank's end.
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
This API can be used to fetch the balance information of a given Bank Account with Federal Bank. The AccountNumber for which the balance is to be retrieved is sent as the input to the API. The API will validate the Account number, and returns such details like Account Status, Balance, Ledger Balance, Available Balance etc.
0 0 n/a
The ‘BBPS Bill Fetch’ API fetches the customer bill details based on the ‘BillerId’ passed. Bill payment Partners of the Bank can make use of this API to validate the subscriber making a bill payment. It would be done before the Bill Pay API so that the subscriber bank account gets debited only in the case when his details get verified.
0 0 n/a
This API will be used for initiating Bill Payment through BBPS using different channels.
0 0 n/a
This API will validate the correctness of biller subscription details. Prior to initiating bill payment, it is required to call this API in case the following two scenarios in Biller MDM Responseare true: a) If Fetch_Requirement = NOT_SUPPORTED b) If SupportBillerValidation = OPTIONAL or MANDATORY
0 0 n/a
The ‘BBPS Biller Master Data Management’ API is used to fetch details related to Billers in the BBPS. When a customer wants to register for Bill payment, system must ensure that correct BillerId and related details are captured. This can be achieved by providing a list of available Billers to the user, using this API, so that he can select the Biller. …
 0 0 n/a
This API is useful to raise a complaint against bill payment transaction or service-related issues. Complaint ID along with the current status is provided, once the complaint gets registered by the consumer.
0 0 n/a
This API is used to enquire about the status of a complaint that was previously registered, based on Complaint ID and Complaint Type.
0 0 n/a
The ‘BBPS Transaction Status API’ can be used by bill payment partner applications, any time, to enquire about the status of any previous bill payment transactions, by the payment reference number or consumer number.
0 0 n/a
This API is used for initiating Bulk Payment (I.e., Many to one bulk payment). Input contains multiple transactions, if initial validation is success +ve ack will be posted back. Then transactions will be processed one by one.
0 0 n/a
Fetch BRE customer details after passing the customer ID.
0 0 n/a
0 0 n/a
API is to generate list of challans in income tax system TIN2.0 on behalf of corporate users of bank.
0 0 n/a
API is to submit remittance for the the challans generated through Bulk Challan interface.
0 0 n/a
API to validate PAN/TAN for bulk challan payment system.
0 0 n/a
This service will allow a calling program to add an Embosser record. This service will validate the key elements (CustomerId, Account Number) in order to ensure that duplicate embosser record doesn’t exists.
0 0 n/a
This Service is used to add Customer account card setup.
0 0 n/a
This Service is used to validate the customer mobile Number by sending OTP to the mobile number.
0 0 n/a
Pounz ECM mail sending API allows external programs and applications to send out emails and track their delivery
0 0 n/a
This API is used to check whether an email id is short lived with email id as input.
0 0 n/a
This service is used for enquiring CIF creation status for federal bank customers.
0 0 n/a
The API captures Customer ID and documents of a customer from the source CIF creation channel/Fintech.
0 0 n/a
This API is for the customer with OTP based. The process is the same as the CKYC generating normal API. Customer ID and documents of a customer are sent to the CKYC central application from the Source CIF creation channel/Fintech .
0 0 n/a
This API is to retrieve a customer's current CKYC status. If this API request is given and this shows the response of the statuses likes- Initiated, Processed, Submitted, Completed, OnError, Re-Initiated.
0 0 n/a
This API is to Update the existing CKYC. This customer will have a CKYC number and that particular number is passed in this API for updation. The response of this API ie the message and an ID is then marked. It carries almost the same process as that like normal based. But the only difference is, it is used for existing customers.
0 0 n/a
0 0 n/a
API used to close the Fixed Deposit account of the customer.
0 0 n/a
API to close the RD account of the customer
0 0 n/a
This API used to close the Smart Deposit account of the customer. Upon closure the proceeds of the account will be credited to the SB account of the customer. If there are multiple SB accounts for the customer, then the SB account configured for the purpose while opening the Smart Deposit will be used.
0 0 n/a
This API can be used for collateral linkage .
0 0 n/a
This API can be used for collateral lodging .
0 0 n/a
API used to create a FD(Fixed Deposit) account for the customer identified by the BC.
0 0 n/a
This API used to create a flexi RD account for the customer identified by the BC.
0 0 n/a
API to open a Smart Deposit account for a customer (CIF) identified by the BC.
0 0 n/a
CASA Additional Info API is used to fetch CASA additional information like Account status, Profit, Balance etc. for the given Account/CustomerID.
0 0 n/a
BPM Search API is used to fetch the details of customer request.
0 0 n/a
This API is invoked by CX to update the final status of file processed at their end. For the file exported from Federal Bank.
0 0 n/a
CASA API is used to fetch the customer/Account holder full account (SB/CA) details.
0 0 n/a
Generatecibilscore API is used to fetch the cibil score details from claps.
0 0 n/a
QuickApplication API is used to quickly apply loan for a customer.
0 0 n/a
CLAPS API is used to fetch the Application Information.
0 0 n/a
Customer Detail API is used to fetch the customer/Account holder’s basic customer details.
0 0 n/a
AverageBalanceOfAccount API retrieves the average balance of an account.
0 0 n/a
CVIEW_CARD_HOT_MARK API which is used to Block/Hotmark the card permanently. Card blocking request would be sent to ATM switch and CBS.
0 0 n/a
CVIEW_CARD_INQUIRY API which is used to get the status and other details of the Card.
0 0 n/a
cviewchequestatuscheck API is used to fetch the status of the given Cheque by giving the account number and Cheque number.
0 0 n/a
SubmitStopChequeRequest API will initiate a request to stop the mentioned cheque number.
0 0 n/a
SubmitDebitCardRequest API will initiate a request for debit card.
0 0 n/a
SubmitAccountOpening API will initiate a request for deposit account opening.
0 0 n/a
cviewfetchaccount API is used to find the upgradable scheme for the existing account holder.
0 0 n/a
BalanceEnquiry API retrieves the balance of an account as per the given date.
0 0 n/a
FetchCardTypeLov API retrieves the card type data using account number detail.
0 0 n/a
FetchTransactionDetails API retrieves the transaction details based on account number and date range.
0 0 n/a
HNICheck API is used to fetch High Net worth Customer using Mobile number and Sectoken.
0 0 n/a
ImpsUpiTransactions API retrieves the IMPS and UPI transaction history.
0 0 n/a
FetchMobileAlertDetails API retrieves the mobile alert registration details of an account number.
0 0 n/a
MobileAlertReport API retrieves the mobile alert details for the given period.
0 0 n/a
FetchAccountMoreInfo API is used to fetch more information based on Account number and Customer Id.
0 0 n/a
SubmitUpgradeScheme API will initiate a request for upgrading scheme of the given account.
0 0 n/a
CX_CREDIT_CARD_BLOCK API which is used to block or unblock the card status
0 0 n/a
ChequeRequestDetails API will fetch cheque request details.
0 0 n/a
AverageBalanceOfCustomers API retrieves average balance of the customer accounts.
0 0 n/a
FetchEmailAlertDetails API retrieves the email alert registration details of an account number.
0 0 n/a
FetchFednetData API retrieves the fednet data based on customer id.
0 0 n/a
Forcast Deposit API is used to fetch the Deposits forcast interest and maturity value.
0 0 n/a
FetchPinStatus API retrieves the debit card pin status.
0 0 n/a
FetchSmsHistory API retrieves history of the SMS sent to the mobile number.
0 0 n/a
CrmDialer API is for pushing various campaign data from CX to MIS table for Aspect outbound dialer integration
0 0 n/a
Disputedetails/CX is a wrapper API, Which is used to fetch the status of dispute and the transactions status logs for all the transactions against a valid dispute case number.
0 0 n/a
EmailStmtActivation API will initiate a request to activate or deactivate email statement.
0 0 n/a
FetchAccountDetails API will initiate a request to retrieve account details.
0 0 n/a
EpayDetails_BillDetails is used to fetch the Epay Bill details of customer.
0 0 n/a
CX_FETCH_CARD_DETAILS API which is used To fetch the details of debit/credit cards of given customer id
0 0 n/a
CX_FETCH_COMIT_CARD_STATUS_REPORT API which is used to fetch the card status change request of the customers.
0 0 n/a
CX_FETCH_COMIT_CHEQUE_REQ_REPORTAPI which is used to fetch Cheque request information by giving the card number along with the period.
0 0 n/a
CX_FETCH_COMIT_LIMIT_UPD_REPORT API which is used to fetch the limit update history.
0 0 n/a
CX_FETCH_COMIT_MOBILE_UPD_REPORT API which is used to fetch the list of transactions of the mobile number changes by the customer/Account holder
0 0 n/a
Comitsmsreport API is used to fetch soft pin request details.
0 0 n/a
Softpinreqat API is used to fetch Soft pin request audit details.
0 0 n/a
CX Comit SoftPin Report API which is used to fetch Soft pin request audit details.
0 0 n/a
CX_FETCH_DEBITCARD_DETAILS API which is used to track customer debit card dispatch details against the given data.
0 0 n/a
EpayDetails_PayDetails API is used to fetch the Epay payment details of customer.
0 0 n/a
EpayDetails_UserDetails API is used to fetch Epay Registration details.
0 0 n/a
PhysicalStmtActivation API will initiate a request to activate or deactivate physical account statement.
0 0 n/a
ImpsUpiAccountBlock API used for block the Account Number and check status
0 0 n/a
Nach MMS mandate report api is used to fetch details of mandates having status as Accepted, Expired, Cancelled, Rejected, Pending Processing.
0 0 n/a
EmailStmtFwdTool API will initiate a request to forward statement to the given email id.
0 0 n/a
0 0 n/a
FetchCardOnOffHistory API retrieves the history of requests for card feature activation and deactivation.
0 0 n/a
Deposits API is used to fetch the details of the customer/account holder.
0 0 n/a
0 0 n/a
EpayDetails_RegDetails is used to fetch the Epay Bill registration details of customer.
0 0 n/a
FederalMobileBankingDeactivation API will deactivate Federal Customers from MobileBanking.
0 0 n/a
Fednet registration Status API is used to fetch the Fednet registered details of the customer/Account holder. Status will be in displayed in the encrypted format.
0 0 n/a
FednetStatus API is used to get status details to a customer about their Fednet application requests in realtime.
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
Loans API is used to fetch the Loan details of Customer/Account holder.
0 0 n/a
Ministatement API is used to fetch 10 transactions from an account provided in the request body.
0 0 n/a
Mobile alert API is used to fetch the customer/Account holder are enabled mobile alert. If yes, then mobile alert registration will be displayed as “Mobile”
0 0 n/a
This api used to fetch offer details that are applicable to given Account/CustomerID.
0 0 n/a
This API is used to insert new inbound file information into Federal Bank DB from CX application.
0 0 n/a
This API is used to update the file received status of RIDC and invoke API call to share the same file information with CX.
0 0 n/a
PROACTIVE_IND API is used to fetch the Customer Indications for the given Customer ID.
0 0 n/a
Service Charge API is used to fetch the customer charges applied to customer.
0 0 n/a
TRV API is used to fetch Total Relationship Value for the given customer.
0 0 n/a
Using this API customer will receive bank account statement of 30 days.
0 0 n/a
This API is used to get the customer details of a particular customer Id.
0 0 n/a
0 0 n/a
0 0 n/a
Using the Customer ID Creation API, a banking correspondence application can create a new Customer ID using the customer creation service of the Bank. To create a customer ID in banking system, the Bank requires identity proof, address proof and other vital information of the Customer. Please consider the following field requirements while generating…
 0 0 n/a
This API provides basic customer details to be shared for issuance of prepaid instrument.
0 0 n/a
0 0 n/a
0 0 n/a
This API is used to get the customer details of a particular customer Id.
0 0 n/a
Using the Loan Customer ID Creation API, a client application can create a new Customer ID to apply for a loan with the Bank. Along with stringent document verification process by the banker, this API ensures the following: 1.Receive Loan Application 2.Document Collection 3.Document Verification Process 4.Sanctioning of the Loan On receiving the loan…
 0 0 n/a
This service is used for creating/registering new card for the given customer id and account number.
0 0 n/a
This API will be used by the partner when a customer enquires to foreclose an account. The customer will be able to see the penalty associated with the FD closure and his actual payout if he wishes to close the FD.
0 0 n/a
Hunter API is used to check the customer information provided by the user is valid at Experian end.
0 0 n/a
Whenever this API is invoked loan amount will be disbursed to the beneficiary account.
0 0 n/a
Bulk Dispute Status API provides the current status of the transactions against the valid dispute case numbers provided. The requester ID, dispute count, dispute case numbers should be valid values in DMP and FBL in order to return the values.
0 0 n/a
This Channel & Questionnaire API returns the list of channels, channel settings, channel questions and question settings from Dispute Management Portal which are authorized to the requestor.
0 0 n/a
Create Dispute API create and save a new dispute in Dispute Management Portal with the values provided.
0 0 n/a
Correspondence API saves the correspondence against a dispute case number.This API returns the status upon saving the correspondence in Dispute Management Portal.
0 0 n/a
Document API save the documents against a dispute case number.
0 0 n/a
This Dispute status check API returns the status of dispute and the transactions status logs for all the transactions against a valid dispute case number.
0 0 n/a
This Transactions API returns the list of transactions between a period for the given Account Number.
0 0 n/a
To create a subfolder inside a main folder. The parentNodeId will be provided for the same
0 0 n/a
Create a new node with a nodeType and a set of meta-data. The nodePropertyQname and nodeTypeQname will be provided if this API is to being consumed.
0 0 n/a
To delete nodes with given node ids.
0 0 n/a
To download a file using the API
0 0 n/a
To upload a file inside a folder. The parentNodeId will be provided for the same.
0 0 n/a
To login and consume the other APIs
0 0 n/a
To rename a node
0 0 n/a
Using the document sharing API, a client application share the captured KYC documents like PAN image to the bank using Account number, Channel Id ,header along with some reserve fields , Document type and documents in base 64 string format..
0 0 n/a
0 0 n/a
EKYC Download KYC Alternate API
0 0 n/a
API used to check the status of the API request sent by the Fintech to create or close the RD
0 0 n/a
This service is used for recharging mobile, DTH etc.
0 0 n/a
This API will validate the correctness of biller subscription details before making Payment.
0 0 n/a
Euro net Partners can make enquiry about the status of the previous bill payment transactions by using this API
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
This API is used to fetch the current status of a loan application request, identified by an Application ID. The Application ID should be the value used during the Loan Application Process. It will return the details of the loan application, like the request processing status, status code, and description, etc.
0 0 n/a
This API fetches an instant loan offer for a given customer (identified by (phone no and channel type), or (card number hash and channel type)) if they are pre-approved. Else it returns the appropriate error code.
0 0 n/a
This API facilitates users to check the status of any Instant Loan API call initiated during the loan process. Details such as API Type and Application ID are to be specified for identifying the particular API and their Loan request.
0 0 n/a
This API is used to submit a loan application based on loan eligibility. Details such as Loan amount, tenure, interest rate, etc. can be customized specifically to the Customer within the limits allowed by the loan offer. The Offer ID received from the Bank for Instant Loan, and the OTP received for authentication should be provided in this API for…
 0 0 n/a
This API fetches the details of a pre-approved instant loan offer for a given customer by the bank if he/she is eligible based on their Phone Number, Account Number (with last 4 digits), Transaction/Loan Amount, and Loan Tenure combination. If the customer is eligible for Instant Loan then details as the maximum loan amount offered, EMI tenure, interest…
 0 0 n/a
This API fetches the details of a pre-approved instant loan offer for a given customer by the bank if he/she is eligible, based on their Phone Number and Account Number (with the last 4 digits) combination. If the customer is eligible for Instant Loan, then details such as maximum loan amount offered, EMI tenure, interest rate, processing fees, etc…
 0 0 n/a
This API fetches the details of a pre-approved instant loan offer for a given customer by the bank if he/she is eligible based on their Phone Number, Card Number (with last 4 digits), Transaction/Loan Amount, and Loan Tenure combination. If the customer is eligible for Instant Loan then details as the maximum loan amount offered, EMI tenure, interest…
 0 0 n/a
This API fetches the details of a pre-approved instant loan offer for a given customer by the bank if he/she is eligible based on their Phone Number and Card Number (with the last 4 digits) combination. If the customer is eligible for Instant Loan, then details such as maximum loan amount offered, EMI tenure, interest rate, processing fees, etc. will be…
 0 0 n/a
This API fetches the details of a pre-approved instant loan offer for a given customer by the bank if he/she is eligible, based on their cust id. If the customer is eligible for Instant Loan, then details such as maximum loan amount offered, EMI tenure, interest rate, processing fees, etc. will be shared.
0 0 n/a
This API fetches the details of a pre-approved instant loan offer for a given customer by the bank if he/she is eligible, based on their PAN and Mobile number. If the customer is eligible for Instant Loan, then details such as maximum loan amount offered, EMI tenure, interest rate, processing fees, etc. will be shared.
0 0 n/a
This API fetches the details of a pre-approved instant loan offer for a given customer by the bank if he/she is eligible, based on their Phone Number. If the customer is eligible for Instant Loan, then details such as maximum loan amount offered, EMI tenure, interest rate, processing fees, etc. will be shared.
0 0 n/a
This API is used to insert offers for a eligible customers.
0 0 n/a
This API is leveraged to create and deliver OTP as SMS for authentication or confirmation as required in the process. Hence the mobile number provided should be a valid number of the Customer, preferably the same number registered with the Bank.
0 0 n/a
This API fetches an instant loan offer for a given customer identified by (phone no) if they are pre-approved. If Eligible, the tenure-based offer eligibility details are returned in response. Else it returns the appropriate error code.
0 0 n/a
This API enables the user to unblock his existing loan. The loan get blocked once the Instant Loan Application API get processed. User should call this API after processing Instant Loan Application API to unblock his existing blocked loan.
0 0 n/a
LoanDetailsFetch API is used to fetch the loan details.
0 0 n/a
This API is designed for Corporates/non-individuals to check whether the customer exists in Bank records or not.
0 0 n/a
Fintech / Service providers increasingly need a secure and reliable means to validate Customers based on the customer data collected from the field or during registration. API Banking of Federal Bank exposes Dedupe_Chk API in order to cater to this need. Service providers can use this API to validate a Customer by providing data collected by them. API…
 0 0 n/a
API used to check the status of the API request sent by the Fintech to create or close the FD.
0 0 n/a
This API call is used for Prepaid card loading by debiting customer account.
0 0 n/a
This API call is used for Prepaid card unloading (refund of unused balance in prepaid card)
0 0 n/a
The Immediate Payment Service (IMPS) provides a robust and real-time fund transfer solution, offering an instantaneous, 24x7, interbank electronic fund transfer service, that could be accessed on multiple channels like Mobile, Internet, ATM, SMS, Branch, etc. This facility is provided by the NPCI. To use IMPS for fund transfer, both Remitter, as well as…
 0 0 n/a
Intrabank Fund Transfer means transferring funds to a beneficiary having an account in the same Bank. This API can be used to transfer funds between two accounts maintained with Federal Bank. The amount will be transferred from Remitter’s account specified by ‘RemitterDetails’ to the Beneficiary’s account specified by ‘BeneficiaryDetails’. There are …
 0 0 n/a
National Electronic Funds Transfer (NEFT) is an electronic funds transfer system maintained by the RBI. It enables Bank customers to transfer funds from any bank branch to any individual having an account with another participating bank branch. The fund transfer is not real-time but takes place in batches that get settled on half-hourly time slots. It…
 0 0 n/a
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…
 0 0 n/a
This service is used to initiate a fund transfer (FT/NEFT/RTGS) via web. API Contains required payment details along with the OTP for validation purpose, API will validate OTP & Beneficiary account with preconfigured account
0 0 n/a
This API generates an OTP, in order to authenticate the user / customer, during subsequent API calls. The API uses the string token value provided in the input to generate the OTP. The OTP will be linked to the loan application via a unique ID and will be sent to the mobile number provided in the input. Hence the mobile number provided in the input…
 0 0 n/a
This API is part of Web version of eKYC. This variant of eKYC has multiple steps to be followed. This is the first step to initiate the eKYC process. This API helps to generate a session ID, which is used in the second step to form a URL.
0 0 n/a
This API can be used to fetch details / status of a loan application request, identified by an applicationId. The applicationId should be the value sent to the Bank as part of Generate OTP API call. If the ApplicationId is valid, this API will return the details of the loan like the loan application request processing status, next EMI date, outstanding…
 0 0 n/a
This API can be used to fetch details of pre-approved personal loan offered to a Customer by the Bank, if he / she is eligible. API requires the masked Account Number and mobile number of the Customer as input, which the Bank uses to identify the Customer, and extend the loan offer. If the Customer mapped to the Account and mobile number is eligible for…
 0 0 n/a
Fetch customer details after passing the customer ID and Authorisation code.
0 0 n/a
This API is used for fetch last updated transaction details from Redis upon user request.
0 0 n/a
This API can be used to collect the gold loan account details jewelry details and agent details collected by fintech during gold loan creation.
0 0 n/a
This API can be used to collect the customer details and ekyc, Aadhar, Un name check, Dedupe etc request ID and details collected by fintech during gold loan creation
0 0 n/a
This API can be used to collect the pledge card details collected by fintech during gold loan creation.
0 0 n/a
This API can be used to enquire the status of API requests initiated by fintech.
0 0 n/a
This API is used for opening Gold Loan account for existing Federal bank customers. Customer Id is a mandatory argument in loan processing. 1) Customer initiates a Gold Loan Request by passing Customer Id and additional required data in the Gold Loan request to GOLD_LOAN_CREATION_Application. 2) GOLD_LOAN_CREATION_Application Validates the Gold…
 0 0 n/a
This API can be used to fetch the details of gold in physical form pledged by the Customer to avail the given gold loan. API returns such details like the Customer Name, sanction limit, account opening date, the gold scheme name and code, interest rates, gross weight and other details of the gold pledged.
0 0 n/a
This API can be used to know the amount outstanding to close a gold loan account, at any point in time since the opening of that account. Request accepts the loan account number and the date on which the Customer wants to close the account. API computes the balance outstanding on the loan account, and additional interests / penalties like pre-closure…
 0 0 n/a
This API fetches KYC details of the Customer who holds the requested Account Number. The Gold Loan Customer KYC Details API is used to gather all the information about a customer who has availed for a gold loan. This information can be used to verify the customer’s identity to complete the onboarding process and then, disburse the loan amount.
0 0 n/a
The Gold Loan Details API fetches the list of all gold loan accounts created within the requested time period.
0 0 n/a
0 0 n/a
This Service is used to enquire Beneficiary Details .
0 0 n/a
API will accept customer’s mobile number and DOB from the BC.
0 0 n/a
At POS, when the Bank offers EMI to a Customer, and once he/she agrees to the EMI and tenure, the offer amount should be blocked by the Bank against that Customer. It is to prevent over-booking by similar other simultaneous transactions by the same Customer. Instant Loan Blocking API gets invoked to block the EMI offer amount against the Customer. API…
 0 0 n/a
Before offering an EMI facility to a Customer, the provider at POS Terminal needs to ensure that the customer is eligible for the loan amount. This API is to check the eligibility of a customer to avail loan equal to the sale amount. While initiating a payment through the POS, an EMI offer gets communicated to the customer. Once the interested customer…
 1 1 By ASPN2024 5 days 2 hours ago
POS Terminal service provider will need to know the processing status/response of each API invocation instantaneously, as these are real-time transactions. API calls, but may not respond within the acceptable time limit, due to slow network connection, increased traffic at the Federal Bank Server infrastructure, etc. There should be a way for the POS…
 0 0 n/a
At POS, when the Bank offers EMI to a Customer, and once he/she agrees to the EMI and tenure, the offer amount would be blocked by the Bank against that Customer. The Customer still has an option to cancel his interest in the EMI offer. There can be a case where the previous transaction Loan Blocking API gets timed out, and the POS Terminal did not…
 0 0 n/a
This service is used generate Instant OTP .
0 0 n/a
This API is used to fetch the details of the given account
0 0 n/a
This API is used to fetch linked accounts to the given Customer Id.
0 0 n/a
This API is used to fetch the statement of the given account on the given date.
0 0 n/a
Using the Loan Account Creation API, a client application can create a new Customer Id to apply for a loan with the Bank. Along with stringent document verification process by the banker, this API ensures the receipt of the Loan Application, Document Collection, performs the Document Verification Process and finally, the sanctioning of the Loan. On…
 0 0 n/a
Disbursement in financial terms is the act of paying out or disbursing money. Loan disbursal API is used for paying out the loan amount to the Customer’s operative account. Input parameters to this API include CustomerID (CIF_ID), Loan Account Number and Loan Amount. This API helps to disburse the loan amount: To the partner’s pool account with Federal…
 0 0 n/a
Loan disbursal enquiry API is used to enquire Loan disbursal status for the customers of Federal Bank. This API accepts the Loan Disbursement Request ID as an input, for which the status will be returned, on successful completion.
0 0 n/a
This service is used for enquiring Loan creation status for federal bank customers.
0 0 n/a
This API is used to create security and link it to an account number. It is mostly used when the security type to be linked is 'jewellery'.
0 0 n/a
0 0 n/a
This API is used to create security and link it to an account number. It is mostly used when the security type to be linked is 'vehicle'.
0 0 n/a
This API helps one to know the status of Loan Account creation request, with the help of a RequestID. It is a simple and hassle-free means for customers to check their Loan Account status. Using this method, the customer can check the loan status from anywhere. The response message contains details like Loan Account status, date/time of account creation…
 0 0 n/a
This Service is used to close the loan account of the customer.
0 0 n/a
This service is used to enquire Payoff / Settlement amount for the given loan account number.
0 0 n/a
Using the Loan Repayment Schedule API, a client application can fetch the the repayment schedule of a loan amount from CBS through back end using Service Request ID, Currency, Interest Rate, Loan Amount, Loan Period, Number of installments, Scheme code, etc. The repayment schedule includes details like Amount paid per installment, the amount split…
 0 0 n/a
LRS eligibility check API is to check whether the customer can able to remit fund outside India, LRS eligibility check is applicable for Resident and NRI
0 0 n/a
LRS rate fetch API is used by Federal bank fintech partners for retrieving the daily conversion rate of Indian rupee .
0 0 n/a
This API is used to get the eligible accounts used for Mutual fund via Fedmobile.
0 0 n/a
This API is used to check whether sufficient balance is available in customer account to initiate the transaction.
0 0 n/a
This API is used to get the customer details for onboarding to mutual fund module via Fedmobile.
0 0 n/a
This API can be used by corporates in order to initiate the E-mandates for their customers. In this case, corporate clients will be consuming the E-Mandate APIs to their website/ web portal/ mobile/Tab device as mentioned below.
0 0 n/a
Using the emandate data sharing API, a client application can fetch the status of all debit E - Mandates registered against an account through back end using Account number, ChannelId and Header along with some reserve fields. The API includes details like payer account number, account type, mandate amount, mandate amount type, umrn number, mandate…
 0 0 n/a
Corporates can use this service to get a list of the live bank in NPCI NACH E-Mandate.
0 0 n/a
Merchant can use this service whenever they want to get the response details of the registered mandates.
0 0 n/a
Destination bank can use this service to check the status of the response they have submitted to ONMAGS.
0 0 n/a
Merchants can use this service to check the status of an initiated request sent to NPCI ONMAGS (Online Mandate Gateway Service).
0 0 n/a
This API would be used for both the versions of eKYC services. After processing the eKYC requests, a unique number is provided to Fintechs. To avoid any fraudulent activities, Fintechs must confirm that, data acquired during the eKYC process and data collected by Fintech to create the Customer ID is of the same person. This API takes the unique number…
 0 0 n/a
NCMC - Money Add through Channels API
0 0 n/a
This api is used to check the Transaction status.
0 0 n/a
This API is useful for a customer to register and de-register the 15G/15H/15HH declaration process for any deposit account, based on request obtained from the customer.
0 0 n/a
This Service is used for delinking the account from the User Device. Customer/Client has to initiate the message with valid device details and linked account number. After receiving the request, the Federal application will validate the given device details and account link status. If the validation is successful, the account gets delinked from the…
 0 0 n/a
This API can be used for enquiring the balance for a given account. The API returns Ledger Balance (available balance + lien balance) and Available balance (balance available for withdrawal at any point of time). In addition, the API returns the Account Holder Name, Account Type and Status also
0 0 n/a
This service is used to download the personal details of a customer from the local database or CERSAI using CKYC Number.
0 0 n/a
This service is used to fetch CKYC details of a customer from a local database or CERSAI.
0 0 n/a
This API is useful to close the deposit account of the customer. Upon closure, the proceeds of the deposit account get credited to the SB account of the customer. If there are multiple SB accounts for the customer, then the SB account configured for the purpose while opening the account is used.
0 0 n/a
Create Fixed Deposit (FD) API: This API is useful to create an FD account for a customer. The request message with all the necessary information needs to be passed in the API. If the Deposit gets opened successfully, the API will respond with the Deposit Account Number and other Deposit Related Details.
0 0 n/a
This API is useful to create an RD account for a customer. The request message with all the necessary information needs to be passed to the API. If Deposit gets opened successfully, the API responds with the Deposit Account Number and other Deposit Related Details.
0 0 n/a
This API is useful to create a new Flexi-RD account for the customer.
0 0 n/a
This service is used to get Customer Details for a given Customer Id. Customer/Client has to pass valid details in Request api. If the validation completes successfully, the API will return SUCCESS response. Note: 1) Kindly follow the below format to generate request id, NEOCUSTDET
0 0 n/a
This service is used as a part of the Account Creation Process to create a new customer ID using this API. Customer/Client has to pass valid essential details in the request. After receiving the request, the Neo Banking application will do Initial validation against the received data. If the validation is successful, the customer ID will get created for…
 0 0 n/a
This API is useful to check the status of the previous API request sent by the customer to create or close the deposit account. The customer or client needs to pass all the required data along with the original transaction Request ID.
0 0 n/a
API is used to fetch interest details of a customer.
0 0 n/a
This service is used for enquiring the status of an initiated API.
0 0 n/a
This API is useful for fetching the details of the given account number.
0 0 n/a
This API is useful for fetching all the linked accounts for a given customer ID.
0 0 n/a
This API is useful for fetching the statement of the given account on any date. The API returns a fixed number of pages in each request explicitly made by the Client application. For each subsequent request, the PageNum in the request should be 1 more than the PageNum from the previous response. Also, the process gets repeated until the “No more…
 0 0 n/a
This Service is useful for transferring the money between two accounts where the beneficiary account is other than the Federal Bank account via IMPS channel. The customer or client needs to pass remitter and beneficiary account details, along with all the required data. Once the validation is successful, then the amount is transferred to the beneficiary…
 0 0 n/a
This Service is useful for transferring the money between two federal bank accounts. The customer or client needs to pass remitter and beneficiary account details, along with all the required data. After receiving the request, the Neo Banking application will check whether the given remitter account gets linked to the given device details along with…
 0 0 n/a
Neo_Mobile_Device_Token_Validation
0 0 n/a
This Service is useful for transferring the money between two accounts where the beneficiary account is other than the Federal Bank account via NEFT channel, which is now available 24x7(including holidays). The customer or client needs to pass remitter and beneficiary account details, along with all the required data. Once the validation is successful,…
 0 0 n/a
This Service is used for completing the account linking process. Once the customer receives the verification OTP on his registered mobile number, the client application will initiate the OTP verification API with the OTP and validity period of account linking. After receiving the request, the Neo Banking application will validate the received OTP. If…
 0 0 n/a
This Service is used for authenticating the user by generating OTP to the registered mobile number. After receiving the request, the Neo banking application will validate the given account number. If the account number is valid and exists in the CBS, an OTP gets triggered to the registered mobile number. The client/Customer has to pass the received OTP…
 0 0 n/a
The API is useful for a customer to transfer funds from an operative account to his/her deposit account.
0 0 n/a
This Service is useful for recurring payment execution. The customer or client needs to pass all the required data, which includes device details, SI token, and payment info like amount and payment mode. After receiving the request, the Neo Banking application will check whether the given SI Token gets linked to (or Created by) the given device details…
 0 0 n/a
This service is useful for modifying existing standing Instruction details. The customer or client needs to pass all the required data, which includes device details, SI token, and the details which need to be modified. After receiving the request, the Neo Banking application will check whether the given SI Token gets linked to (or Created by) the…
 0 0 n/a
This service is useful for revoking an existing standing Instruction. The customer or client needs to pass all the required data, which includes device details and SI token. After receiving the request, the Neo Banking application will check whether the given SI Token gets linked to(or Created by) the given device, along with the SI token and Cred data…
 0 0 n/a
This Service is useful for creating a Standing Instruction Token, which can be used for recurring transactions like bill payment and recharges. The customer or client needs to pass remitter and beneficiary account details along with all the required data, which includes recurring payment information. After receiving the request, the Neo Banking…
 0 0 n/a
This Service is useful for transferring the money between two accounts where the beneficiary account is other than the Federal Bank account via RTGS channel where a real-time settlement takes place. The customer or client needs to pass remitter and beneficiary account details, along with all the required data. Once the validation is successful, then the…
 0 0 n/a
As a part of the Account Creation Process, once a Customer ID gets created, then a new Account Number will be created and mapped for the given Customer ID by using this API.
0 0 n/a
This service is useful for changing the below-mentioned card parameters for the given Customer ID and Account Number. a. Card Freeze/Un-Freeze b. Domestic ON/OFF c. International ON/OFF d. ECOM ON/OFF e. NFC ON/OFF Customer/Client has to pass valid details in Request API along with the particular Request Type. If the validation is successful, then the …
 0 0 n/a
This service is useful for creating/registering a new card for the given Customer ID and Account Number. Customer/Client has to pass valid details in the API Request. The Neo Banking application will do Initial validation against the data. If all such validation is successful, a positive ACK is sent to the client application. In the case of validation…
 0 0 n/a
This service is useful to get details such as Card CVV and Expiry Date for a given card number. Customer/Client has to pass valid details in Request API. If the validation completes successfully, the API will return a SUCCESS response along with the Encrypted card details.
0 0 n/a
This service is useful to get the card delivery status for a newly issued physical card. Customer/Client has to pass valid details in Request API. If the validation completes successfully, the API will return Card dispatch details.
0 0 n/a
This service is useful for retrieving the details regarding the card linked to a given Customer ID and Account Number. Customer/Client has to pass valid details in the API Request. If the validation is successful, the details of the card get returned successfully
0 0 n/a
This Service is used to fetch and enquire about the current limit settings and maximum allowable limits for a given card.
0 0 n/a
This Service is used to update and modify the limit settings within the maximum allowable limits for a given card.
0 0 n/a
This service is used to Set / Reset the PIN for a given card. The customer should initiate the PIN set during the first onboarding session along with the card creation process. TokenValidation Flag needs to be enabled, and the Token gets passed in the request message at the first PIN set process. In all other cases, whether to Reset / Change PIN, OTP…
 0 0 n/a
This API will be used by the partner to update the nomination details of an account. Account number, Nominee details, etc. will be fetched, and Nominee details will be updated accordingly.
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
This API is used to add details for Document Execution. All the details required for generating and signing the document is provided in this api.
0 0 n/a
This api is used to download the completed document
0 0 n/a
Almost all APIs which Federal Bank exposes follow the asynchronous processing model. It means that, for a given request, the processing may not happen immediately, and hence the actual response is not returned. The API will return an acknowledgment message instead, which signifies that the request is received. When the transaction processing completes…
 0 0 n/a
The purpose of this API is to verify the PAN Number to validate Customers based on the customer data collected during the Account Opening process.
0 0 n/a
API used to get PAN Aadhaar details of a given PAN number.
0 0 n/a
The PAN Verification API verifies the status of a given PAN along with additional details associated with the PAN such as name, Aadhaar seeding status and type of pan
0 0 n/a
This API used for transfer of funds from a customer’s SB account to his/her own linked deposit accounts. This service will be used by the BC, only to credit the deposit account(s) opened by the customer and where instruction is received by the customer to deposit the amount into a specific deposit account.
0 0 n/a
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. 1) It fetches the name of the account in the other Bank 2) It also gives a confirmation whether the fund transfer to that account will be…
 0 0 n/a
This API is used to fetch basic details of the customer with mobile number as input.
0 0 n/a
Personal Loan Business Rule Engine-Fetch Auth Token API can be used to fetch Authentication token for calling the bre decision API. The username and password to call to this service will be provided by federal bank at the time of onboarding.
0 0 n/a
Personal Loan Business Rule Engine - Fetch BRE Decision API will return the BRE decision on eligibility for a loan based on the inputs passed in the API along with the Authentication token..
0 0 n/a
This Service is used to block the amount. To block amount the user has to pass the amount, account number to the service. Api will validate the details, if validation is success api will block the fund in given client account and return the response with status.
0 0 n/a
This service used for bulk payments on account which is lien marked .It will call different payment channels from BankingAPI Service based on HTTP header value.
0 0 n/a
This API can be used to submit a loan application for a Customer, based on the loan eligibility response received from “Get Instant Loan Offer” API call. Loan amount, tenure, interest rate etc. can be customized specific to the Customer, within the limits allowed by the loan offer. The offerId received from the Bank for the “Get Loan Offer” API call,…
 0 0 n/a
pull SMS Activation
0 0 n/a
0 0 n/a
API used for registration and de-registration of 15G/15H/15HH registration, based on request obtained from the customer.
0 0 n/a
0 0 n/a
This application is used for validating the other bank customer account by using IMPS Channel. User should provide the Account Number and IFSC of the other bank cutomer he want to validate. If the transaction completed successfully we can conclude beneficiary account is valid, otherwise appropriate response will be given back.
0 0 n/a
This message allows the user to request for Statement of a particular account on a particular date.
0 0 n/a
This API is used for transferring the money to the bank account maintained by a Bank other than a Federal bank, via IMPS channel. API accepts details of the remitter in RemitterDetails object, the beneficiary details – including AccountNumber and IFSC - in BeneficiaryDetails object and the amount to remit. The amount gets credited to the Beneficiary…
 0 0 n/a
This API transfers the amount to the beneficiary account through the IntraBank channel. API accepts details of the remitter in RemitterDetails object, the beneficiary details in BeneficiaryDetails object and the amount to be remitted. The amount will be credited to the Beneficiary account, if the transaction is successful. Intra Bank Fund transfer API…
 0 0 n/a
This API performs fund transfer via the NEFT channel. The funds get transferred to any account maintained with any Bank in India. API accepts details of the remitter in RemitterDetails object, the beneficiary details – including AccountNumber and IFSC - in BeneficiaryDetails object, and the amount to be remitted. The amount gets credited to the…
 0 0 n/a
This API transfers amounts via RTGS. With the Remittance Fund Transfer RTGS APIs, transactions will be settled in real time. API accepts details of the remitter in RemitterDetails object, the beneficiary details – including AccountNumber and IFSC - in BeneficiaryDetails object, and the amount to be remitted. The amount will be credited to the…
 0 0 n/a
This application is used for validating the other bank customer account by using IMPS Channel. User should provide the Account Number and IFSC of the other bank customer wants to validate, then Rs.1-/ Transaction will be initiated to the customer. If the transaction completed successfully we can conclude beneficiary account is valid, otherwise…
 0 0 n/a
This API is used to get the status of the transactions initiated through any of the Remittance Fund Transfer APIs. That is, these APIs help the exchanges to know the status of a transaction that had initiated via RTGS, NEFT, InterBank, or IMPS channels. API accepts the reference number of the original fund transfer transaction as Org_ReferenceId field.
0 0 n/a
This Service is used for transferring the money to a bank account across the banks in India via UPI Channel using UPI VPA (Virtual Payment Address).
0 0 n/a
This API is used to validate the UPI Virtual ID (VPA - Virtual Payment Address) of the beneficiary before initiating any payment using UPI Channel.
0 0 n/a
Through the Remittance Vostro Balance Enquiry APIs, applications can get the balance for the account registered to a user, which is maintained with Federal Bank.
0 0 n/a
This service helps the exchanges to know the status of a transaction which is processed via FT, IMPS, NEFT, UPI Channels, the exchanges has to pass valid Reference Id and Channel Name of a transaction in [Org_ReferenceId] and [TxnType] fields of a request.
0 0 n/a
Remitter Fetch API facilitate the fetching of remitter details.
0 0 n/a
Using the Loan Repayment Schedule API, a client application can fetch the repayment schedule of a loan account from CBS through back end using Request ID, message Date & Time, Account Number, and sol Id. The repayment schedule includes details like Amount to be paid per installment, Outstanding principal amount, Currency code, etc.
0 0 n/a
0 0 n/a
Using the Loan Repayment Schedule API, a client application can fetch the repayment schedule of a loan account from CBS through back end using Request ID, message Date & Time, Account Number, and sol Id. The repayment schedule includes details like Amount to be paid per installment, Outstanding principal amount, Currency code, etc.
0 0 n/a
Generic Email API to send various email communications .
0 0 n/a
Session validation API in FedNet
0 0 n/a
Get card details API used to get the details of the credit card and debit card customer by giving the card number.
0 0 n/a
This API is used to have a SI status inquiry API so that the partner can check the status of any SI and update it. The input will be Account Number. The API will provide Standing Instruction details like SI_START_DATE, SI_END_DATE, FIXED_AMT, etc. associated with given account number.
0 0 n/a
API to check the status of the API request sent by the Fintech to create or close the Smart Deposit.
0 0 n/a
The SMS API service is developed and hosted by Federal Bank to support applications to send SMS messages to Customers. This service is extended to Fintech / Service provider applications to communicate with their customers, as well.
0 0 n/a
The SMS API service is developed and hosted by Federal Bank to support applications to send SMS messages to Customers. This service is extended to Fintech / Service provider applications to communicate with their customers, as well.
0 0 n/a
0 0 n/a
0 0 n/a
Third party account collection API is used to fetch the status of the virtual KYC.
0 0 n/a
This API is used to verify the TPV. TPV Check API - Mobile + Card last Combination
0 0 n/a
This API is used to verify the TPV. TPV Check API - Card Hash Combination
0 0 n/a
In any transaction processing system, some transactions might fail abruptly, or the client may not receive the response during the stipulated time and the call times out. The transaction enquiry API can be used to enquire the status of any Transaction – identified by the Org_ReferenceId. API responds with the status, and status reason of the transaction…
 0 0 n/a
Reserve Bank of India (RBI) has made it mandatory for Banks to conduct necessary checks before opening a new account to ensure that the identity of the customer does not match with any person with known criminal background or with banned entities such as terrorist individuals or terrorist organizations. As per extant RBI guidelines, Banks are required…
 0 0 n/a
This Service is used for checking if the incoming name is available in the UN check DB.
0 0 n/a
This REST API will return status as “S” in its response, if the name does not appear in the UN Name check database, and the service provider can subsequently continue to on-board that customer. API will return “F” along with the existing blacklisted user’s First-Name, Second-Name and Address available in its database, otherwise. Further scrutiny must be…
 0 0 n/a
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).
0 0 n/a
This API is used to validate the UPI Virtual ID (VPA - Virtual Payment Address) of the beneficiary before initiating any payment using UPI Channel.
0 0 n/a
Merchant will receive this API whenever there is a credit happens to his virtual id
0 0 n/a
0 0 n/a
This API is to initiate a transaction where the merchant is requesting funds from the remitter using the remitter’s virtual ID. The merchant is a pre-configured and registered entity with the Bank. For this process, the merchant sends a COLLECT request with the specific UPI address of the Customer. When the Customer accepts the COLLECT request and pays…
 0 0 n/a
Using this API, the physical Bank Account mapped to the user’s Virtual ID can be de-linked. The account Number to be de-linked along with the Virtual ID details are passed as part of the MerchantBody section of the request message.
0 0 n/a
This API lets customers disable/delete the Virtual ID of a User. Once the Virtual ID gets disabled/deleted, no more UPI transactions are allowed further using that particular Virtual ID.
0 0 n/a
API used for block the Account Number and check status
0 0 n/a
API to get the customer account numbers against the mobile number
0 0 n/a
This API lets the customer change his/her default account linked to a user’s Virtual ID with a new Bank Account of that user. The details such as the new Account Number, the Virtual ID, the DefaultAcctFlag, etc. are specified as part of the MerchantBody section of the request message.
0 0 n/a
This API is to get the outbound response of the PAY and COLLECT transactions initiated by the user. API will give the response of the PAY or COLLECT transactions, represented by the “id” attribute in the request message.
0 0 n/a
Using this API, Merchant can initiate a payment from his / her account to a Customer. The request message has details of the Payee VPA in the MerchantBody section. It has other details like Amount, Payer VPA, etc. This API follows an asynchronous processing model. On receiving a PAY request from the Merchant, Federal Bank will validate the request and…
 0 0 n/a
This API Allows PSP to enquirye balance of a user
0 0 n/a
This API allows the PSPs to request for the status of the transaction. The PSPs must request for status only after the specified timeout period.
0 0 n/a
If Merchant wants to create new virtual id or add new account then Merchant has to call this API.
0 0 n/a
If Merchant wants to delete account then Merchant has to call this API.
0 0 n/a
If Merchant wants to delete virtual id then merchant has to call this API
0 0 n/a
PSPs to find the list of accounts linked to the mobile or Adhaar by a particular account provider. If the destination bank name is not known details of account provider will be fetched from central mapper. As part of ATM PIN introduction, the issuer bank has to respond with new cred block with subtype as ATM PIN, its type and length, where PIN length…
 0 0 n/a
API will provide the issuer capability to verify ATM PIN for all the registered PSP with UPI.
0 0 n/a
This API allows the PSPs to request and cache the list of public keys of NPCI and UIDAI. Trusted and certified libraries will be used by PSPs for credential capture and PKI public key encryption at capture time. These libraries will be provided by NPCI.
0 0 n/a
This API allows the PSPs to request the list of all registered PSPs for local caching. This data should be used for validating payment address before initiating the transaction
0 0 n/a
NPCI offers a mechanism to protect customers from attempts to spoof well known merchants such as LIC, Indian Railways, e-commerce players, telecom players, bill payment entities, etc.
0 0 n/a
NPCI offers a mechanism to protect customers from attempts to spoof well known merchants such as LIC, Indian Railways, e-commerce players, telecom players, bill payment entities, etc. This mechanism is an API, where the PSPs can manage, and access the common collection of verified address entries. NPCI, with the help of PSPs, will define a process to…
 0 0 n/a
This API allows the customer to set new UPIPIN for the first time.PSP will send the “FORMAT1”or “FORMAT2”to the remitter banks based on their readiness. Cred block with subtype “ATMPIN” is allowed only for FORMAT2.
0 0 n/a
If Merchant wants to change his default account to another then merchant has to initiate this API
0 0 n/a
0 0 n/a
0 0 n/a
This API allows the PSPs to request for an OTP for a particular customer
0 0 n/a
0 0 n/a
This API allows PSP to request pending messages against a given mobile number or Aadhaar number.
0 0 n/a
0 0 n/a
0 0 n/a
0 0 n/a
This API will be used to inform the status of the transaction to PSP’s
0 0 n/a
This API is required for providing a unified channel for setting and changing UPIPIN across various account providers. This is critical to ensure customers can easily change UPIPIN via their mobile or by going to a biometric terminal at a BC. Currently this API is restricted to NPCI and banks to be used via USSD or bank mobile/BC application
0 0 n/a
This API will be used by the PSPs when their customer wants to add a beneficiary within PSP application (for sending & collecting money).
0 0 n/a
Using this API, merchants can initiate refund against a UPI payment. This API follows an asynchronous processing model. On receiving a PAY request from the Merchant, Federal Bank will validate the request and will send an Acknowledgement to the Merchant. If the request is valid, Federal Bank will then send a transaction response message (RespPay) to the…
 0 0 n/a
This API lets the merchants confirm the response of any UPI transaction. At first, the federal bank will send the “ReqTransactionConfirm” API to Merchant. For which the merchants should respond with “ACK” immediately. Post that Merchant Application should call this "RespTransactionConfirm" API to the Federal bank, the bank will send “ACK” to Merchant.
0 0 n/a
This API lets a merchant know the status of a transaction, which was previously initiated by him /her. The TransactionId for which the status needs to be enquired is specified as part of TranEnqBody of the request message.
0 0 n/a
This message will be sent to merchant whenever there is a credit happens to his virtual id. In case of collect, merchant won’t receive this API because he will be receiving final response
0 0 n/a
UPI Services is currently available only to Resident Indian customers inside FedMobile. NRI customers are currently restricted from using this feature. As per NPCI, there are no restrictions in extending this feature to NRI customers. Hence, we propose extending the feature to our customers who are in Non-Resident Status & they will be allowed to use…
 0 0 n/a
This API is to validate the Virtual ID of a Customer before initiating PAY / COLLECT requests, to make sure the transaction gets initiated against the correct party. Details of the Merchant and Customer Virtual ID are to be specified as part of the MerchantBody section of the request message. The response will contain the name of the Account holder if…
 0 0 n/a
This API lets you create a new Virtual ID or add a new Bank Account to the given Virtual ID. Virtual ID (also called Virtual Payment Address or VPA) is a unique ID that has to be created for each user to send and accept money via UPI. Once a Virtual ID is created and mapped against the user’s existing Bank Account, the user can share his / her Virtual…
 0 0 n/a
0 0 n/a
With this API, the client can initiate an account statement request, for a specific period. The API will return details of all transactions that have happened in the specified Virtual Account during the period. This will help the client to easily manage and track collections, generate reports, handle recon activities etc.
0 0 n/a
The Add Virtual account API is used to create a Virtual Account. The client application can create multiple virtual accounts under a single physical account number, by calling this API with required input. If the call is successful and the new Virtual Account Number is accepted, API will return success message. API will return a failure message with…
 0 0 n/a
This API is used to deactivate a Virtual Account whenever required. The Virtual Account System validates the input and processes the request.Depending on success or failure, the API returns the appropriate response code and reason. Once the Virtual Account is deactivated, then it cannot be re-activated again. Also, no more transactions are accepted or …
 0 0 n/a
Almost all APIs which Federal Bank expose follow asynchronous processing model. This means that, for a given request, the processing may not happen immediately, and hence the actual response cannot be returned to the request. The API will return an Acknowledgement message instead, that signifies that the request has been received. When the transaction…
 0 0 n/a
Transaction Enquiry API can be used to query the status of any transaction that was previously originated by the client application. System will try to identify the transaction by the given ‘TranId’ and validates the corresponding Institution Code and Virtual Account Number. If the TranId, Institution Code and Virtual Account Number given in the input…
 0 0 n/a
Federal Bank allows any number of Virtual Account(s) to be created against a physical account for a given period only. Once the validity period expires the Virtual Account will be automatically deactivated by the Bank. The Update Virtual Account API can be used by the end user applications to update – extend / contract - the validity period of a given…
 0 0 n/a
BC passes the verification code to the Bank for validation and if the code is correct, then Bank provides the customer’s account details to the BC app for linkage. At Bank’s end this registration would be marked, and only on such registered accounts/customers would bank allow account statement to be pulled by the BC.
0 0 n/a
Send the authorisation code to the registered mobile number of the customer.
0 0 n/a
This Voice OTP API is used to verify & authenticate the customer mobile number. This verification is done by making a call to the registered mobile number & playing a sequence of digits. In order to verify the mobile number, the user needs to confirm the played sequence of digits.
0 0 n/a
0 0 n/a

Support

Looking for help? Check out the frequently asked questions on our support page.

Contact us

Send us a message. We'll get back to you as soon as we can.

Get Social