This API is used to validate the Virtual ID of a Customer. This can be used prior to initiating PAY / COLLECT requests, to make sure the transaction is being initiated against the correct party.
Details of the Merchant and Customer Virtual ID are specified as part of the MerchantBody section of the request message. Response will contain the Name of the Account holder, if the Virtual ID specified by PayeeAddress is valid.
This API follows an asynchronous processing model. On receiving address validation request (ReqValAdd) from the Merchant, Federal Bank will validate the request and send an Acknowledgement to the Merchant. If the request is valid, Federal Bank will then send a response message (RespValAdd) to the Merchant with the name of the Party / Customer whose Virtual ID was mentioned in the request. The RespValAdd response message will have the same TransactionId as the original request message. Merchant must acknowledge receipt of the RespValAdd message, which will in turn complete the process flow.
Merchant should always perform Address Validation request before initiating either PAY or COLLECT Request API, to make sure the transaction is effected against the correct Party.
Paths
/validate_address
Definitions
{
"type": "object",
"properties": {
"ReqValAdd": {
"type": "object",
"properties": {
"MerchantHeader": {
"type": "object",
"properties": {
"SenderUserId": {
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production",
"type": "string"
},
"SenderPassword": {
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production",
"type": "string"
},
"SenderCode": {
"description": "Contact Federal Bank API_Support Team for the value to be used for UAT and Production",
"type": "string"
}
}
},
"MerchantBody": {
"type": "object",
"properties": {
"TransactionId": {
"description": "Unique and random ID to be generated by the client, to identify each request. In UAT, this value should always start with ‘FDR’. In Production env. the pattern will be different; contact API_Support team. Eg. FDRuh87try654gftferk5453",
"type": "string"
},
"TransactionType": {
"description": "Value should be ValAdd",
"type": "string"
},
"PayerAddress": {
"description": "Merchant’s Virtual ID",
"type": "string"
},
"PayerName": {
"description": "Merchant’s Name",
"type": "string"
},
"PayeeAddress": {
"description": "Virtual ID to be validated. API will validate the Virtual ID specified in this field.",
"type": "string"
}
}
}
}
}
}
}
{
"type": "object",
"properties": {
"RespValAdd": {
"type": "object",
"properties": {
"TransactionId": {
"type": "string",
"description": "Unique and random ID to be generated by the client, to identify each request. In UAT, this value should always start with ‘FDR’. In Production env. the pattern will be different; contact API_Support team. Eg. FDRuh87try654gftferk5453"
},
"ResponseCode": {
"type": "string"
},
"Response": {
"type": "string"
}
},
"description": ""
}
}
}
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"
}
}
}
}
}