--- swagger: "2.0" info: x-ibm-name: upiauthenticationdetailsapi title: UPI_ Authentication_Details_API version: 2.1.0 description: Merchant will receive this API whenever there is a credit happens to his virtual id schemes: - https basePath: /upi consumes: - application/json produces: - application/json securityDefinitions: appSecret: type: apiKey description: "" in: header name: X-IBM-Client-Secret appId: type: apiKey in: header name: X-IBM-Client-Id security: - appId: [] appSecret: [] x-ibm-configuration: testable: true enforced: true phase: realized paths: /authentication_details: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/AuthenticationDetails_Response' 400: description: Bad request schema: $ref: '#/definitions/AuthenticationDetails_errorResponse' 500: description: Internal Server Error schema: $ref: '#/definitions/AuthenticationDetails_errorResponse' parameters: - name: req required: false in: body schema: $ref: '#/definitions/AuthenticationDetails_Request' definitions: AuthenticationDetails_Request: description: "" type: object properties: ReqAuthDetails: type: object properties: TransactionId: type: string MessageId: type: string Remarks: type: string CustomerReference: type: string TransactionType: type: string Amount: type: string VerifiedName: type: string PayeeMCCCode: type: string PayeeAddress: type: string PayeeName: type: string PayerAddress: type: string PayerName: type: string PayerType: type: string PayerMCCCode: type: string PayerAcctNum: type: string PayerIFSC: type: string PayerAccType: type: string InitiationMode: type: string PurposeCode: description: The purpose field is specially used for SEBI txn type: string AuthenticationDetails_errorResponse: 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 AuthenticationDetails_Response: description: "" type: object properties: UPIRespAuthDetails: 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: RespAuthDetails: type: object properties: UPIVersion: description: Version of the UPI Value should be ‘2.0’. type: string TransactionId: description: Unique and random id for each request. In uat this value always should start with 'FDR' (Production it will be different). Ex.”FDR345YBHHJB345ghg type: string ReqMsgId: description: This value should be echo backed that is the value of MessageId received in ReqAuthDetais API. type: string TransactionType: type: string ResponseCode: description: This should be valid one from npci specification. We will share the list of response codes doc given by NPCI. type: string Reason: description: This should be valid one from npci specification. We will share the list of response codes doc given by NPCI. type: string Remarks: type: string CustomerReference: type: string Amount: type: string VerifiedName: type: string PayeeMCCCode: type: string PayeeType: type: string PayeeAcctNum: description: Merchant Account number where funds will be credited. type: string PayeeIFSC: description: IFSC of the Merchant bank. type: string PayeeAccType: description: It should be CURRENT or SAVINGS type: string PayeeAddress: type: string PayeeName: type: string PayerAddress: type: string PayerName: type: string PayerType: type: string PayerMCCCode: type: string PayerAcctNum: type: string PayerIFSC: type: string PayerAccType: type: string InitiationMode: type: string PurposeCode: description: The purpose field is specially used for SEBI txn type: string MerchantDetails: type: object properties: SubCode: description: MCC code of the merchant type: string Id: description: Merchant Id type: string StoreId: description: Store id type: string TerminalId: description: Terminal id type: string Type: description: Merchant type value should be (SMALL|LARGE) type: string Genre: description: Value should be (OFFLINE|ONLINE) type: string OnBoardingType: description: Value should be (BANK|AGGREGATOR) type: string BrandName: description: Brand any of the merchant type: string LegalName: description: Legal Name of the merchant type: string Franchise: description: Franchise agent name type: string OwnershipType: description: Type of Ownership type: string AuthenticationDetails_Response_Ack: description: "" type: object properties: Ack: type: object properties: API: type: string 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 ResponseCode: type: string Response: type: string tags: [] x-ibm-endpoints: - endpointUrl: https://devgateway.federalbank.co.in/fedbnkdev/dev type: - production - development ...