This API is used to validate the UPI Virtual ID (VPA - Virtual Payment Address) of the beneficiary before initiating any payment using UPI Channel.
API Support
production
development
https://devgateway.federalbank.co.in/fedbnkdev/dev
Paths
/upi_val_add
post /upi_val_add
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/upi_val_add
Try this operation
Definitions
{
"type": "object",
"properties": {
"respUrl": {
"type": "string",
"description": "The client application has to 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"
},
"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. “federal000130”"
},
"tranDate": {
"type": "string",
"description": "Date on which this transaction is initiated, in “DD-MM-YYYY” format. E.g. “12-06-2019”"
},
"PayerAddress": {
"type": "string",
"description": "The UPI Virtual Id of the Payer. E.g. “bankingapi@fede”. API will validate this address."
},
"PayerName": {
"type": "string",
"description": "Alphanumeric field where the Name of the Payer can be specified."
},
"PayeeAddress": {
"type": "string",
"description": "The UPI Virtual Id of the Payee. E.g. “npcirem@fedepsp”"
}
}
}
{
"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”"
},
"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-04-13 17:43:11.053213”"
},
"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"
}
}
}
}
}