{"templateId":"markdown","versions":[{"version":"v1","label":"v1","link":"/products/fx/forward-fxrates","default":true,"active":true,"folderId":"0592dff7"}],"sharedDataIds":{"sidebar":"sidebar-products/fx/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/fx/openapi"},"props":{"metadata":{"markdoc":{"tagList":["partial","badge","code-snippet","admonition"]},"custom_product":"FX","type":"markdown"},"seo":{"title":"Forward FX rates","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 05 June 2025 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/fx/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Badge","attributes":{"size":"small","fontWeight":"bold","color":"white","mt":"0rem","mb":"0.5rem","px":"1rem","py":"0.5rem","borderRadius":"6rem","bg":"red"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Coming soon"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"forward-fx-rates","__idx":0},"children":["Forward FX rates"]},{"$$mdtype":"Tag","name":"Badge","attributes":{"size":"small","fontWeight":"bold","color":"white","mt":"0rem","mb":"0.5rem","px":"1rem","py":"0.5rem","borderRadius":"6rem","bg":"var(--wp-colour-light-blue)"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Account Payout customers only"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Lock a forward FX rate for a specific currency pairing and amount for a future date up to 30 days."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-a-contract-with-fixed-fx-rates","__idx":1},"children":["Create a contract with fixed FX rates"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Step 1:"]}," Create a contract in pending state and retrieve the FX rate."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-started","__idx":2},"children":["Get started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start using our FX API by ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/fx#set-your-headers"},"children":["setting your headers"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: {your_credentials}\nContent-Type: application/vnd.worldpay.foreignexchange-v1+json\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request","__idx":3},"children":["Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/foreignExchange/contract/"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body","__idx":4},"children":["Request body"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/fx-contract-create.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"effectiveDate\": \"2024-07-23\",\n  \"sourceCurrency\": \"USD\",\n  \"targetCurrency\": \"EUR\",\n  \"targetAmount\": \"10\",\n  \"entity\": \"000689\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters","__idx":5},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field name"},"children":["Field name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data type/format"},"children":["Data type/format"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Min-max length"},"children":["Min-max length"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Validation criteria"},"children":["Validation criteria"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be six characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["effectiveDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A future date when the contract becomes available and can be used."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["YYYY-MM-DD"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date must be within 30 days in the future."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sourceCurrency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source currency for the contract."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":["ISO 4217 currency codes"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["targetCurrency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Target currency for the payout."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":["ISO 4217 currency codes"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["targetAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The total amount for your forward FX contract and future payout request in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["targetCurrency"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1-10 digits"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be a positive value up to two decimal places."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":6},"children":["Response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"successful-response-example","__idx":7},"children":["Successful response example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/fx-contract-create-success.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"contractId\": \"C0000000BS\",\n    \"targetAmount\": 10,\n    \"sourceAmount\": 10.927221155755790812556360558,\n    \"status\": \"Pending\",\n    \"effectiveDate\": \"2024-07-23\",\n    \"quote\": {\n        \"quoteId\": \"Q0000000GH\",\n        \"sourceCurrency\": \"USD\",\n        \"targetCurrency\": \"EUR\",\n        \"entity\": \"000689\",\n        \"intent\": \"FORWARD FX\",\n        \"rateId\": \"325990\",\n        \"status\": \"Pending\",\n        \"rate\": 0.91514575,\n        \"quoteStartTime\": \"2024-07-23T00:00:00.000Z\",\n        \"quoteExpiryTime\": \"2024-07-23T23:59:59.999Z\"\n    }\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"successful-response-fields","__idx":8},"children":["Successful response fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field name"},"children":["Field name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data type/format"},"children":["Data type/format"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contractId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique ID for the new contract."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["targetAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The total amount of currency required for this contract."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Numeric (1-10 digits)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sourceAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source amount is calculated using this formula: sourceAmount = targetAmount / BidRate"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Numeric"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Status of the contract. ",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Pending\""]}," - for a new contract"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[" ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Active\""]}," - for an activated contract"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["effectiveDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A future date when the contract becomes available and you can use it."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["intent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction type (intention) for which rates are retrieved."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["quoteId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique ID of the quote."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sourceCurrency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Debiting currency code."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":["ISO 4217 currency codes"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["targetCurrency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Crediting currency code."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":["ISO 4217 currency codes"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rateId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ID of the rate request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Status of the quote."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The quoted rate."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Numeric"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["quoteStartTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Datetime representation in UTC of when the quote starts."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["datetime (UTC)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["quoteExpiryTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Datetime representation in UTC of when the quote expires."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["datetime (UTC)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have created the contract you must activate it. You can only activate the contract within the first 60 minutes after you have created it."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"activate-contract","__idx":9},"children":["Activate contract"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Step 2:"]}," Activate the contract so you can use it for an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/account-payouts/openapi/single-payout"},"children":["account payout"]}," with a future date up to 30 days."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-1","__idx":10},"children":["Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/foreignExchange/contract/C0000000BS"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-1","__idx":11},"children":["Request body"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/fx-contract-enable.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"status\": \"ACTIVE\",\n  \"entity\": \"000689\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-1","__idx":12},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field name"},"children":["Field name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data type/format"},"children":["Data type/format"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Min-max length"},"children":["Min-max length"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Validation criteria"},"children":["Validation criteria"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AN"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be six characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contractId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique contract ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["11"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-1","__idx":13},"children":["Response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"successful-response","__idx":14},"children":["Successful response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HTTP response code 204"]}," for a successful request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"error-response-example","__idx":15},"children":["Error response example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/fx-contract-error-example.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\r\n    \"errorName\": \"invalidContract\",\r\n    \"message\": \"Pending Forward FX Contract has expired\"\r\n}"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"error-response-codes","__idx":16},"children":["Error response codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error"},"children":["Error"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scenario"},"children":["Scenario"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unauthorizedRequest"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request is unauthorized"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unauthorized request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Forbidden."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldIsMissing"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing currency/effectiveDate/targetAmount value"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing currency/effectiveDate/targetAmount."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notFound"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong URL."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notFound"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contract for given input does not exist"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contract for given input does not exist."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["internalErrorOccurred"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Something went wrong"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal error. Please speak to your Worldpay Implementation Manager for further information."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invalidContract"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pending forward FX contract has expired"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You've tried to enable an expired contract."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldHasInvalidValue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EffectiveDate must be within the next 30 days"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The date is outside of the 30 day limit of the contract enablement."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next steps"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/account-payouts/v2/openapi"},"children":["account payout"]}," using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["quoteId"]}," returned in your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#response"},"children":["contract creation response"]}]}]},"headings":[{"value":"Forward FX rates","id":"forward-fx-rates","depth":1},{"value":"Create a contract with fixed FX rates","id":"create-a-contract-with-fixed-fx-rates","depth":2},{"value":"Get started","id":"get-started","depth":2},{"value":"Request","id":"request","depth":3},{"value":"Request body","id":"request-body","depth":4},{"value":"Parameters","id":"parameters","depth":3},{"value":"Response","id":"response","depth":3},{"value":"Successful response example","id":"successful-response-example","depth":4},{"value":"Successful response fields","id":"successful-response-fields","depth":4},{"value":"Activate contract","id":"activate-contract","depth":2},{"value":"Request","id":"request-1","depth":3},{"value":"Request body","id":"request-body-1","depth":4},{"value":"Parameters","id":"parameters-1","depth":3},{"value":"Response","id":"response-1","depth":3},{"value":"Successful response","id":"successful-response","depth":4},{"value":"Error response example","id":"error-response-example","depth":4},{"value":"Error response codes","id":"error-response-codes","depth":4}],"frontmatter":{"seo":{"title":"Forward FX rates"}},"lastModified":"2026-05-13T07:59:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/fx/forward-fxrates","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}