{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/openapi/fxapi/operation/getFXQuoteV3/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/openapi/fxapi/operation/getFXQuoteV3/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Foreign Exchange API\",\"version\":\"2.2.4\"},\"servers\":[{\"url\":\"https://sandbox-security-uat.finzly.io/auth/realms/BANKOS.UAT.SANDBOX.CUSTOMER/protocol/openid-connect/token\",\"description\":\"Authentication\",\"variables\":{\"tenant\":{\"description\":\"Tenant\",\"default\":\"sandbox\"}}}],\"security\":[{\"oAuth2\":[\"roles\"]}],\"tags\":[{\"name\":\"Foreign Exchange\",\"description\":\"Foreign Exchange (FX) is the trading of one currency for another. For example, one can swap the U.S. dollar for the euro.\\n\\nForeign Exchange Finzly FX APIs enables third-parties, banks, and bank's downstream partners to initiate and manage FX trades for their customers.\\n\\nFollowing use cases helps you to understand the current FX capabilities exposed via Finzly Connect APIs\\n   \\n 1. Get FX Quote \\n 2. Accept FX Quote\\n 3. Reject FX Quote\\n 4. Get FX Trade\\n 5. Cover FX Trade\\n 6. Cancel FX Trade\\n\"}],\"paths\":{\"/v2/fx/quote\":{\"post\":{\"tags\":[\"Foreign Exchange\"],\"summary\":\"Get FX Quote\",\"description\":\"⚠️ This endpoint is deprecated and will be removed in future releases. Please use `/v3/fx/quote` instead.\\nRequest quote for FX trade      \\n\",\"operationId\":\"getFXQuote\",\"requestBody\":{\"description\":\"Quote request attributes to get the quote for a given ccy pair\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXQuoteRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXQuoteResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Response to the Get FX Quote\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXQuoteResponse\"}}}}},\"deprecated\":true}},\"/v3/fx/quote\":{\"post\":{\"tags\":[\"Foreign Exchange\"],\"summary\":\"Get FX Quote\",\"description\":\"Request quote for FX trade\",\"operationId\":\"getFXQuoteV3\",\"requestBody\":{\"description\":\"Quote request attributes to get the quote for a given ccy pair\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3FXQuoteRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXQuoteResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of validation errors encountered in the request.\\n\\nThe request was invalid due to malformed syntax or failed validation rules.\\nThis may include missing required fields, incorrect data formats, or invalid account information within the payment batch.\\n\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Human-readable message describing the error.\",\"example\":\"The product type is required.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifier.\",\"example\":\"QUOTE_PRODUCTTYPE_REQUIRED\"}}}}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of authentication/authorization errors encountered while processing the request.\\n\\nThe request lacks valid authentication credentials.\\nEnsure a valid access token or API key is included in the request headers.\\n\",\"items\":{\"required\":[\"code\",\"message\"],\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing why the request was unauthorized.\",\"example\":\"The request is denied since the request does not contain the authorized/valid request.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code that identifies the origin of the error.\",\"example\":\"QUOTE_AUTH_ERROR\"}}}}}}}}},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of authorization errors encountered while processing the request.\\n\\nThe client is authenticated but does not have the necessary permissions to perform this operation or access the requested resource.\\n\",\"items\":{\"required\":[\"code\",\"message\"],\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Human-readable message describing why the request was forbidden.\",\"example\":\"The user is not authorized to perform this operation, please contact the administrator for support.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code that identifies the type of authorization error.\",\"example\":\"FX_AUTH_ERROR\"}}}}}}}}},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of internal errors encountered during processing.\\n\\nThe server encountered an unexpected condition that prevented it from fulfilling the request. This could be due to a system error, database failure, or other internal issues.\\n\",\"items\":{\"required\":[\"code\",\"message\"],\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Description of the internal error.\",\"example\":\"Unexpected error occurred while processing the request.\"},\"code\":{\"type\":\"string\",\"description\":\"Internal error code for tracking and debugging.\",\"example\":\"FX_INTERNAL_ERROR\"}}}}}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Response to the Get FX Quote\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXQuoteResponse\"}}}}}}},\"/v2/fx/accept\":{\"put\":{\"tags\":[\"Foreign Exchange\"],\"summary\":\"Accept FX Quote\",\"description\":\"Accept FX Quote\",\"operationId\":\"acceptFXQuote\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXAcceptQuoteRequest\"}}}},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXAcceptQuoteResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"FX Quote acceptance response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXAcceptQuoteResponse\"}}}}}}},\"/v2/fx/{quoteUUID}/reject\":{\"put\":{\"tags\":[\"Foreign Exchange\"],\"summary\":\"Reject FX Quote\",\"description\":\"Reject FX Quote\",\"operationId\":\"rejectFXQuote\",\"parameters\":[{\"name\":\"quoteUUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"FX Quote universally unique identifier (UUID)\"}}],\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXRejectQuoteResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"FX Quote rejection response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXRejectQuoteResponse\"}}}}}}},\"/v2/fx/{forexContractNo}\":{\"get\":{\"tags\":[\"Foreign Exchange\"],\"summary\":\"Get FX Trade information\",\"description\":\"Get FX trade information\",\"operationId\":\"getFXTradeInformation\",\"parameters\":[{\"name\":\"forexContractNo\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"FX Contract Number\"}}],\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXTradeInfoResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Response to the Get FXTrade request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXTradeInfoResponse\"}}}}}}},\"/v2/fx/{forexContractNo}/cover\":{\"post\":{\"tags\":[\"Foreign Exchange\"],\"summary\":\"Cover FX trade\",\"description\":\"Cover FX trade\",\"operationId\":\"coverFXTrade\",\"parameters\":[{\"name\":\"forexContractNo\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"FX Contract Number\"}}],\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXCoverTradeResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Response to the cover trade request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXCoverTradeResponse\"}}}}}}},\"/v2/fx/{forexContractNo}/cancel\":{\"delete\":{\"tags\":[\"Foreign Exchange\"],\"summary\":\"Cancel FX trade\",\"description\":\"Cancel FX Trade\",\"operationId\":\"cancelFXTrade\",\"parameters\":[{\"name\":\"forexContractNo\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"FX Contract Number\"}}],\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXTradeCancelResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"FX Trade cancelation response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FXTradeCancelResponse\"}}}}}}}},\"components\":{\"schemas\":{\"Error\":{\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Error code assigned by the system\",\"example\":\"invalidMethod\"},\"description\":{\"type\":\"string\",\"description\":\"Error description to provide addtional details about the error code\",\"example\":\"Invalid HTTP method used\"}}},\"FXQuoteRequest\":{\"required\":[\"buyCurrency\",\"customerId\",\"customerIdType\",\"productType\",\"sellCurrency\"],\"properties\":{\"channel\":{\"type\":\"string\",\"description\":\"The channel name set by the FX quote request system such as API, TELLER etc. This is an optional field and defaulted to API if it is not provided. The channel names should be defined in the Finzly system before it can be used in the API.\",\"example\":\"ONLINE.\"},\"customerId\":{\"type\":\"string\",\"description\":\"The value based on the customerIdType\",\"example\":\"112344\"},\"customerIdType\":{\"type\":\"string\",\"description\":\"CustomerId type\",\"example\":\"CustomerUID\",\"enum\":[\"CustomerUID\",\"CustomerShortName\",\"CustomerId\",\"DDA\"]},\"sellCurrency\":{\"type\":\"string\",\"description\":\"Sell Currency\",\"example\":\"EUR\"},\"buyCurrency\":{\"type\":\"string\",\"description\":\"Buy Currency\",\"example\":\"INR\"},\"fundingAmount\":{\"type\":\"number\",\"description\":\"Funding Amount. Only one is needed between fundingAmount and transferAmount\",\"example\":10000},\"transferAmount\":{\"type\":\"number\",\"description\":\"Beneficiay receive amount. Only one is needed between fundingAmount and transferAmount\",\"example\":1000},\"productType\":{\"type\":\"string\",\"description\":\"FX financial instrument such SPOT or FORWARD\",\"example\":\"SPOT\",\"enum\":[\"SPOT\",\"FORWARD\"]},\"tenor\":{\"type\":\"string\",\"description\":\"The length of time remaining before a financial contract expires. Only one is needed between tenor or valueDate. e.g. SPOT, ON, TN\",\"example\":\"SPOT\"},\"valueDate\":{\"type\":\"string\",\"description\":\"The delivery date on which counterparties to a transaction agree to settle their respective obligations by making payments and transferring ownership.Only one is needed between tenor or valueDate.The date format is in mm-dd-yyyy.\",\"example\":\"01-01-2020\"}}},\"V3FXQuoteRequest\":{\"required\":[\"buyCurrency\",\"productType\",\"sellCurrency\"],\"properties\":{\"channel\":{\"type\":\"string\",\"description\":\"Channel through which the FX quote request is initiated (e.g., API, TELLER).\\nThis is optional and defaults to `API` if not provided.\\nChannel values must be pre-configured in the Finzly system.\\n\",\"example\":\"API.\"},\"customerIdType\":{\"type\":\"string\",\"description\":\"Specifies the type of customer identifier used.\\nThis field is optional when `accountNumber` is provided.\\n\",\"example\":\"CustomerUID\",\"enum\":[\"CustomerUID\",\"CustomerShortName\",\"CustomerId\"]},\"customerId\":{\"type\":\"string\",\"description\":\"Required when `customerIdType` is `CustomerId`.\\nRepresents the dynamic customer ID from the Customer system.\\n\",\"example\":\"112344\"},\"customerUID\":{\"type\":\"string\",\"description\":\"Required when `customerIdType` is `CustomerUID`.\\nRepresents the unique identifier assigned to the customer.\\n\",\"example\":\"112344\"},\"customerShortName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Required when `customerIdType` is `CustomerShortName`.\\nRepresents the unique short name assigned to the customer.\\n\",\"example\":\"ShortName\"},\"accountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Required when the customer is a cash customer.\\nRepresents the account number used to initiate the payment.\\n\",\"example\":\"1020304050\"},\"sellCurrency\":{\"type\":\"string\",\"description\":\"Currency being sold.\",\"example\":\"EUR\"},\"buyCurrency\":{\"type\":\"string\",\"description\":\"Currency being bought.\",\"example\":\"INR\"},\"fundingAmount\":{\"type\":\"number\",\"description\":\"Amount debited from the sender.\\nProvide either `fundingAmount` or `transferAmount`, but not both.\\n\",\"example\":10000},\"transferAmount\":{\"type\":\"number\",\"description\":\"Amount to be received by the beneficiary.\\nProvide either `transferAmount` or `fundingAmount`, but not both.\\n\",\"example\":1000},\"productType\":{\"type\":\"string\",\"description\":\"Type of FX product. Supported values are `SPOT` and `FORWARD`.\",\"example\":\"SPOT\",\"enum\":[\"SPOT\",\"FORWARD\"]},\"tenor\":{\"type\":\"string\",\"description\":\"The length of time remaining before a financial contract expires. Only one is needed between tenor or valueDate. e.g. SPOT, ON, TN\",\"example\":\"SPOT\"},\"valueDate\":{\"type\":\"string\",\"description\":\"The delivery date on which counterparties to a transaction agree to settle their respective obligations by making payments and transferring ownership.Only one is needed between tenor or valueDate.The date format is in mm-dd-yyyy.\",\"example\":\"01-01-2030\"}}},\"FXAcceptQuoteRequest\":{\"required\":[\"quoteUUID\"],\"properties\":{\"quoteUUID\":{\"type\":\"string\",\"description\":\"FX Quote universally unique identifier (UUID)\",\"example\":\"123e4567-e89b-12d3-a456-426614174000\"},\"autoCover\":{\"type\":\"boolean\",\"description\":\"This is an optional field. Set the value to true if auto cover is needed during the acceptance of FX quote.\",\"example\":true},\"autoCoverDelay\":{\"type\":\"integer\",\"description\":\"Deprecated. This field is ignored and should not be sent.Previously, this optional field was required when autoCover was set to true.For consumer FX quotes, the allowed autoCoverDelay was 30 to 120 minutes.For non-consumer quotes, the allowed autoCoverDelay was 0 to 120 minutes.\",\"example\":30,\"deprecated\":true}}},\"FXAcceptQuoteResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"FXQUOTE002\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"<failure reason>\"},\"data\":{\"type\":\"object\",\"properties\":{\"forexContractNo\":{\"type\":\"number\",\"description\":\"FX contract number assigned by the system after acceptance.\",\"example\":22354325},\"tradeDate\":{\"type\":\"string\",\"description\":\"The trade date is the date on which a transaction was executed. The date format is in yyyy-mm-dd.\",\"example\":\"2020-01-01\"},\"ccyPair\":{\"type\":\"string\",\"description\":\"A currency pair is the quotation of two different currencies, with the value of one currency being quoted against the other\",\"example\":\"USDEUR\"},\"direction\":{\"type\":\"string\",\"description\":\"Buy or Sell\",\"example\":\"Buy\"},\"baseCcy\":{\"type\":\"string\",\"description\":\"The base currency is the first currency stated in a currency pair quote\",\"example\":\"USD\"},\"baseAmount\":{\"type\":\"number\",\"description\":\"Base currency amount\",\"example\":80.65},\"quoteCcy\":{\"type\":\"string\",\"description\":\"The second currency is the quote currency, which states how much of the quote currency is required to buy one unit of the base currency.\",\"example\":\"USD\"},\"quoteAmount\":{\"type\":\"number\",\"description\":\"Quote currency amount\",\"example\":79.78},\"tenor\":{\"type\":\"string\",\"description\":\"The length of time remaining before a financial contract expires. Only one is needed between tenor or valueDate. e.g. SPOT, ON, TN\",\"example\":\"SPOT\"},\"exchangeRate\":{\"type\":\"number\",\"description\":\"The price of one currency in terms of the other\",\"example\":1.2,\"default\":0},\"valueDate\":{\"type\":\"string\",\"description\":\"The delivery date on which counterparties to a transaction agree to settle their respective obligations by making payments and transferring ownership.Only one is needed between tenor or valueDate. The date format is in yyyy-mm-dd.\",\"example\":\"2020-01-01\"},\"referenceSpotRate\":{\"type\":\"number\",\"description\":\"the offered rate\",\"example\":100},\"referenceFwdPoints\":{\"type\":\"number\",\"description\":\"The number of basis points added to or subtracted from the current spot rate of a currency pair to determine the forward rate for delivery on a specific value date\",\"example\":100},\"executionTime\":{\"type\":\"string\",\"description\":\"The execution time\"}}}}},\"FXRejectQuoteResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"FXQUOTE003\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"<failure reason>\"},\"data\":{\"type\":\"object\",\"properties\":{\"quoteUUID\":{\"type\":\"string\",\"description\":\"FX Quote universally unique identifier (UUID)\",\"example\":\"123e4567-e89b-12d3-a456-426614174000\"},\"fxQuoteStatus\":{\"type\":\"string\",\"description\":\"FX Quote status after rejection\",\"example\":\"Rejected\"}}}}},\"FXCoverTradeResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"FX001\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"<failure reason>\"},\"data\":{\"type\":\"object\",\"properties\":{\"forexContractNo\":{\"type\":\"string\",\"description\":\"FX contract number assigned by the system for a given customer trade.\",\"example\":\"123898\"},\"coverTradeNo\":{\"type\":\"string\",\"description\":\"Unique cover trade number assigned by the system.\",\"example\":\"990919\"},\"externalPricingSystemRefId\":{\"type\":\"string\",\"description\":\"Unique reference id provided by the external system\",\"example\":\"R1274878\"},\"channel\":{\"type\":\"string\",\"description\":\"Channel associated with the cover trade.\",\"example\":\"API\"},\"customerIdType\":{\"type\":\"string\",\"description\":\"CustomerId type associated with the cover trade\",\"example\":\"CustomerUI\",\"enum\":[\"CustomerUID\",\"CustomerShortName\",\"CustomerId\",\"DDA\"]},\"customerId\":{\"type\":\"string\",\"description\":\"The value based on the customerIdType associated with the cover trade\",\"example\":\"112344\"},\"tradeDate\":{\"type\":\"string\",\"description\":\"The trade date is the date on which a transaction was executed. The date format is in yyyy-mm-dd.\",\"example\":\"2020-01-01\"},\"valueDate\":{\"type\":\"string\",\"description\":\"The delivery date on which counterparties to a transaction agree to settle their respective obligations by making payments and transferring ownership.Only one is needed between tenor or valueDate. The date format is in yyyy-mm-dd.\",\"example\":\"2020-01-01\"},\"ccyPair\":{\"type\":\"string\",\"description\":\"A currency pair is the quotation of two different currencies, with the value of one currency being quoted against the other\",\"example\":\"USDEUR\"},\"direction\":{\"type\":\"string\",\"description\":\"Buy or Sell\",\"example\":\"Buy\"},\"baseCcy\":{\"type\":\"string\",\"description\":\"The base currency is the first currency stated in a currency pair quote\",\"example\":\"USD\"},\"baseAmount\":{\"type\":\"number\",\"description\":\"Base currency amount\",\"example\":1000},\"quoteCcy\":{\"type\":\"string\",\"description\":\"The second currency is the quote currency, which states how much of the quote currency is required to buy one unit of the base currency.\",\"example\":\"EUR\"},\"quoteAmount\":{\"type\":\"number\",\"description\":\"Quote currency amount\",\"example\":955.08},\"tenor\":{\"type\":\"string\",\"description\":\"The length of time remaining before a financial contract expires. Only one is needed between tenor or valueDate. SPOT, TN, ON\",\"example\":\"SPOT\"},\"allInRate\":{\"type\":\"number\",\"description\":\"The all in rate associated with the cover trade\",\"example\":0.98,\"default\":0},\"referenceSpotRate\":{\"type\":\"number\",\"description\":\"the offered rate\",\"example\":100}}}}},\"FXQuoteResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\"},\"data\":{\"type\":\"object\",\"properties\":{\"quoteUUID\":{\"type\":\"string\",\"description\":\"FX Quote universally unique identifier (UUID)\",\"example\":\"123e4567-e89b-12d3-a456-426614174000\"},\"expiryTime\":{\"type\":\"number\",\"description\":\"The price of one currency in terms of the other\",\"example\":1.2,\"default\":0},\"invertedRate\":{\"type\":\"number\",\"description\":\"Time in seconds after which the FX quote will expire\",\"example\":0.83,\"default\":0},\"baseCcy\":{\"type\":\"string\",\"description\":\"Sell Currency\",\"example\":\"EUR\"},\"quoteCcy\":{\"type\":\"string\",\"description\":\"Buy Currency\",\"example\":\"INR\"},\"spotRate\":{\"type\":\"number\",\"description\":\"The price of one currency in terms of the other.\",\"example\":1.2},\"fwdPoints\":{\"type\":\"number\",\"description\":\"The number of basis points added to or subtracted from the current spot rate of a currency pair to determine the forward rate for delivery on a specific value date\",\"example\":100},\"allInRate\":{\"type\":\"number\",\"description\":\"All in rate\",\"example\":0.83},\"quoteAmount\":{\"type\":\"number\",\"description\":\"Funding Amount. Only one is needed between fundingAmount and transferAmount\",\"example\":10000},\"baseAmount\":{\"type\":\"number\",\"description\":\"Beneficiay receive amount. Only one is needed between fundingAmount and transferAmount\",\"example\":1000},\"valueDate\":{\"type\":\"string\",\"description\":\"The delivery date on which counterparties to a transaction agree to settle their respective obligations by making payments and transferring ownership.Only one is needed between tenor or valueDate. The date format is in yyyy-mm-dd.\",\"example\":\"2020-01-01\"},\"externalPricingSystemRefId\":{\"type\":\"string\",\"description\":\"Unique reference id returned by the external system provider.\",\"example\":\"76be97b7-2dbb-4852-98ae-f32549c9f7c6\"}}}}},\"FXTradeInfoResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"FX001\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"<failure reason>\"},\"data\":{\"type\":\"object\",\"properties\":{\"forexContractNo\":{\"type\":\"string\",\"description\":\"FX contract number assigned by the system for a given trade.\",\"example\":\"123898\"},\"tradeDate\":{\"type\":\"string\",\"description\":\"The trade date is the date on which a transaction was executed. The date format is in yyyy-mm-dd.\",\"example\":\"2020-01-01\"},\"ccyPair\":{\"type\":\"string\",\"description\":\"A currency pair is the quotation of two different currencies, with the value of one currency being quoted against the other\",\"example\":\"USDEUR\"},\"direction\":{\"type\":\"string\",\"description\":\"Buy or Sell\",\"example\":\"Buy\"},\"baseCcy\":{\"type\":\"string\",\"description\":\"The base currency is the first currency stated in a currency pair quote\",\"example\":\"USD\"},\"baseAmount\":{\"type\":\"number\",\"description\":\"Base currency amount\",\"example\":1000},\"quoteCcy\":{\"type\":\"string\",\"description\":\"The second currency is the quote currency, which states how much of the quote currency is required to buy one unit of the base currency.\",\"example\":\"EUR\"},\"quoteAmount\":{\"type\":\"number\",\"description\":\"Quote currency amount\",\"example\":900},\"tenor\":{\"type\":\"string\",\"description\":\"The length of time remaining before a financial contract expires. Only one is needed between tenor or valueDate. e.g. SPOT, ON, TN\",\"example\":\"SPOT\"},\"exchangeRate\":{\"type\":\"number\",\"description\":\"The price of one currency in terms of the other\",\"example\":1.2,\"default\":0},\"valueDate\":{\"type\":\"string\",\"description\":\"The delivery date on which counterparties to a transaction agree to settle their respective obligations by making payments and transferring ownership.Only one is needed between tenor or valueDate. The date format is in yyyy-mm-dd.\",\"example\":\"2020-01-01\"},\"referenceSpotRate\":{\"type\":\"number\",\"description\":\"the offered rate\",\"example\":100},\"referenceFwdPoints\":{\"type\":\"number\",\"description\":\"The number of basis points added to or subtracted from the current spot rate of a currency pair to determine the forward rate for delivery on a specific value date\",\"example\":100},\"executionTime\":{\"type\":\"string\",\"description\":\"The execution time\",\"example\":\"1800\"},\"counterpartyId\":{\"type\":\"string\",\"description\":\"The counterpartyId associated with the fx trade.\",\"example\":\"11950\"}}}}},\"FXTradeCancelResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"FX001\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"<failure reason>\"},\"data\":{\"type\":\"object\",\"properties\":{\"forexContractNo\":{\"type\":\"string\",\"description\":\"FX contract number assigned by the system for a given trade.\",\"example\":\"123898\"},\"tradeStatus\":{\"type\":\"string\",\"description\":\"Trade status after trade cancelation\",\"example\":\"Cancelled\"}}}}}},\"securitySchemes\":{\"oAuth2\":{\"type\":\"oauth2\",\"description\":\"BankOS OpenBanking API uses OAuth 2.0 authcodeflow with PKCE for end user authorization or implicit grant flow for system API accounts. A support request to Finzly is required to use implicit grant flow.\",\"flows\":{\"authorizationCode\":{\"authorizationUrl\":\"https://sandbox-security-uat.finzly.io/auth\",\"tokenUrl\":\"https://sandbox-security-uat.finzly.io/auth/realms/BANKOS.UAT.SANDBOX.CUSTOMER/protocol/openid-connect/token\",\"scopes\":{\"roles\":\"manage\"}}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Node.js\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/openapi/fxapi/overview/","redocItemId":"tag/Foreign-Exchange/operation/getFXQuoteV3","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"}]}},"requestLogin":false,"lastModified":"2026-04-08T07:11:12.000Z"},"seo":{"title":"Get FX Quote"}}},"pageContext":{"id":"1761a2d4-cd87-579f-a44e-d3567795ce59operation/getFXQuoteV3__redocly content/openapi/fxapi/operation/getFXQuoteV3/","seo":{"title":"Get FX Quote","description":"Request quote for FX trade","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"openapi/fxAPI.page.yaml#operation/getFXQuoteV3","pageBaseUrl":"/openapi/fxapi","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/openapi/fxapi/operation/getFXQuoteV3/","sidebarName":"training","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"fxApi","id":"fxApi","title":"fxApi","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}