{"items":[{"type":"link","label":"FX","link":"/products/fx/openapi","routeSlug":"/products/fx/openapi","content":{"contentType":"overview","meta":{"name":"FX"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/fx/@v1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/fx/@v1/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"csharp","title":"C#","lang":"C#"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"FX (1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Foreign Exchange."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Authorization: {your_credentials}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Authorization: {your_credentials}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replace "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{your_credentials}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for any request you send to our FX APIs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Accept: application/vnd.worldpay.foreignexchange-v1+json\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Accept: application/vnd.worldpay.foreignexchange-v1+json\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We use the Accept header to identify which version of our API you are using."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must use the Accept header for any request you send to our FX APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS whitelisting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whitelist the following URLs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://try.access.worldpay.com/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Account Payouts customers only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay.com/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - MCP and Account Payouts customers"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure you use DNS whitelisting, not explicit IP whitelisting. When"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you make a request within Access Worldpay, you should always cache the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response returned."},"children":[]}]}]}]}],"sectionId":"/products/fx/openapi"}],"sectionId":"/products/fx/openapi"}]}]}},{"label":"Get FX rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/getfxrates","routeSlug":"/products/fx/openapi/other/getfxrates","metadata":{"seo":{"title":"Get FX rates","description":"Retrieve an FX rate for a particular payment method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFXrates","name":"Get FX rates","isWebhook":false,"pointer":"/paths/~1foreignExchange~1rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get FX rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an FX rate for a particular payment method."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"intent","in":"query","schemaId":"schema_390","description":"Transaction type (intention) for which rates should be retrieved."},{"name":"entity","in":"query","schemaId":"schema_391","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Multi-Currency Pricing customers, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an MCP Account Identifier (PartyID- Merchant Company ID, Unique ID given to you during the onboarding process.) for which rates should be retrieved. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For Account Payout customers, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a six-digit reference given to you by your Worldpay Implementation Manager during the onboarding process."},"children":[]}]}]}],"example":"100001"},{"name":"sourceCurrency","in":"query","schemaId":"schema_392","description":"The transaction currency code. If not supplied, the response contains rates for all source currencies against the target currency.","example":"USD"},{"name":"targetCurrency","in":"query","schemaId":"schema_392","description":"Your funding (settlement) currency code. If not supplied, the response contains rates for all target currencies against the source currency.","example":"EUR"}],"pointer":"/paths/~1foreignExchange~1rates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_393","required":true},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_394","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1foreignExchange~1rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/foreignExchange/rates","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[{"name":"intent","in":"query","required":false,"schemaId":"schema_390"},{"name":"entity","in":"query","required":false,"example":"100001","schemaId":"schema_391"},{"name":"sourceCurrency","in":"query","required":false,"example":"USD","schemaId":"components/schemas/CurrencyCode"},{"name":"targetCurrency","in":"query","required":false,"example":"EUR","schemaId":"components/schemas/CurrencyCode"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.worldpay.foreignexchange-v1+json","schemaId":"schema_393"},{"name":"WP-CorrelationId","in":"header","required":false,"example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_394"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/foreignExchange/rates","href":"other/getfxrates","openApiOperationId":"getFXrates","summary":"Get FX rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK response if the request is valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ExternalRateResponse"}},"schemaId":"components/schemas/ExternalRateResponse"},{"code":"400","description":"BAD REQUEST response if the request is not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse400","exampleIds":["paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not correct","paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"]}},"schemaId":"components/schemas/ErrorResponse400","exampleIds":["paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not correct","paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"]},{"code":"401","description":"UNAUTHORIZED response if credentials are invalid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]},{"code":"403","description":"FORBIDDEN response if entitlements are not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]},{"code":"404","description":"NOT FOUND response","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]},{"code":"500","description":"Internal server error","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}],"pointer":"/paths/~1foreignExchange~1rates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalRateResponse","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ExternalRateResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse400","exampleIds":["paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not correct","paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse400","exampleIds":["paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not correct","paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1rates/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getfxrates"}],"panels":[]}]},"httpPath":"/foreignExchange/rates"},{"label":"Create FX quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/postfxquote","routeSlug":"/products/fx/openapi/other/postfxquote","metadata":{"seo":{"title":"Create FX quote","description":"Lock the FX rate for a specific currency pairing. For Account Payouts customers only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postFXquote","name":"Create FX quote","isWebhook":false,"pointer":"/paths/~1foreignExchange~1quote/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create FX quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lock the FX rate for a specific currency pairing. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Account Payouts customers only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_393","required":true},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_394","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1foreignExchange~1quote/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeSchemas":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/postCreateQuoteItems","exampleIds":["paths/~1foreignExchange~1quote/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new quote"]}},"schemaId":"components/schemas/postCreateQuoteItems","exampleIds":["paths/~1foreignExchange~1quote/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new quote"],"pointer":"/paths/~1foreignExchange~1quote/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/foreignExchange/quote","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.worldpay.foreignexchange-v1+json","schemaId":"schema_393"},{"name":"WP-CorrelationId","in":"header","required":false,"example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_394"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/postCreateQuoteItems","exampleIds":["paths/~1foreignExchange~1quote/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new quote"]}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/foreignExchange/quote","href":"other/postfxquote","openApiOperationId":"postFXquote","summary":"Create FX quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/postCreateQuoteItems","exampleIds":["paths/~1foreignExchange~1quote/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new quote"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeSchemas":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/postCreateQuoteItems","exampleIds":["paths/~1foreignExchange~1quote/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new quote"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK response if the request is valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ExternalPostQuoteResponse"}},"schemaId":"components/schemas/ExternalPostQuoteResponse"},{"code":"400","description":"BAD REQUEST response if the request is not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse400Quote","exampleIds":["paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not valid","paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"]}},"schemaId":"components/schemas/ErrorResponse400Quote","exampleIds":["paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not valid","paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"]},{"code":"401","description":"UNAUTHORIZED response if credentials are invalid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]},{"code":"403","description":"FORBIDDEN response if Entitlements are not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]},{"code":"404","description":"NOT FOUND response","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]},{"code":"500","description":"Internal server error","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}],"pointer":"/paths/~1foreignExchange~1quote/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalPostQuoteResponse","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ExternalPostQuoteResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse400Quote","exampleIds":["paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not valid","paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse400Quote","exampleIds":["paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not valid","paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/postfxquote"}],"panels":[]}]},"httpPath":"/foreignExchange/quote"},{"label":"Retrieve an FX quote","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/getfxquote","routeSlug":"/products/fx/openapi/other/getfxquote","metadata":{"seo":{"title":"Retrieve an FX quote","description":"Retrieving an existing FX quote.For Account Payouts customers only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFXquote","name":"Retrieve an FX quote","isWebhook":false,"pointer":"/paths/~1foreignExchange~1quote/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an FX quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieving an existing FX quote."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Account Payouts customers only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"entity","in":"query","schemaId":"schema_395","description":"6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process.","required":true,"example":"100001"},{"name":"quoteId","in":"query","schemaId":"schema_396","description":"Unique ID of the quote.","required":true,"example":"Q000000001"}],"pointer":"/paths/~1foreignExchange~1quote/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_393","required":true},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_394","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1foreignExchange~1quote/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/foreignExchange/quote","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[{"name":"entity","in":"query","required":true,"example":"100001","schemaId":"schema_395"},{"name":"quoteId","in":"query","required":true,"example":"Q000000001","schemaId":"schema_396"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.worldpay.foreignexchange-v1+json","schemaId":"schema_393"},{"name":"WP-CorrelationId","in":"header","required":false,"example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_394"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/foreignExchange/quote","href":"other/getfxquote","openApiOperationId":"getFXquote","summary":"Retrieve an FX quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK response if the request is valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ExternalGetQuoteResponse"}},"schemaId":"components/schemas/ExternalGetQuoteResponse"},{"code":"401","description":"UNAUTHORIZED response if credentials are invalid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]},{"code":"403","description":"FORBIDDEN response if Entitlements are not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]},{"code":"404","description":"NOT FOUND response","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]},{"code":"500","description":"Internal server error","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}],"pointer":"/paths/~1foreignExchange~1quote/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalGetQuoteResponse","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ExternalGetQuoteResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1quote/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getfxquote"}],"panels":[]}]},"httpPath":"/foreignExchange/quote"},{"label":"Create an external contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/postcontract","routeSlug":"/products/fx/openapi/other/postcontract","metadata":{"seo":{"title":"Create an external contract","description":"Create an external contract to lock a forward FX rate. For Account Payouts customers only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postContract","name":"Create an external contract","isWebhook":false,"pointer":"/paths/~1foreignExchange~1contract/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an external contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an external contract to lock a forward FX rate. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Account Payouts customers only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_393","required":true},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_394","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1foreignExchange~1contract/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeSchemas":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/postCreateContractItems","exampleIds":["paths/~1foreignExchange~1contract/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new contract"]}},"schemaId":"components/schemas/postCreateContractItems","exampleIds":["paths/~1foreignExchange~1contract/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new contract"],"pointer":"/paths/~1foreignExchange~1contract/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/foreignExchange/contract","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.worldpay.foreignexchange-v1+json","schemaId":"schema_393"},{"name":"WP-CorrelationId","in":"header","required":false,"example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_394"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/postCreateContractItems","exampleIds":["paths/~1foreignExchange~1contract/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new contract"]}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/foreignExchange/contract","href":"other/postcontract","openApiOperationId":"postContract","summary":"Create an external contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/postCreateContractItems","exampleIds":["paths/~1foreignExchange~1contract/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new contract"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeSchemas":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/postCreateContractItems","exampleIds":["paths/~1foreignExchange~1contract/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new contract"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK response if the request is valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ExternalPostContractResponse"}},"schemaId":"components/schemas/ExternalPostContractResponse"},{"code":"400","description":"BAD REQUEST response if the request is not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse400Quote","exampleIds":["paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/EffectiveDate is longer than 30 days","paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"]}},"schemaId":"components/schemas/ErrorResponse400Quote","exampleIds":["paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/EffectiveDate is longer than 30 days","paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"]},{"code":"401","description":"UNAUTHORIZED response if credentials are invalid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]},{"code":"403","description":"FORBIDDEN response if Entitlements are not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]},{"code":"404","description":"NOT FOUND response","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]},{"code":"500","description":"Internal server error","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}],"pointer":"/paths/~1foreignExchange~1contract/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalPostContractResponse","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ExternalPostContractResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse400Quote","exampleIds":["paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/EffectiveDate is longer than 30 days","paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse400Quote","exampleIds":["paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/EffectiveDate is longer than 30 days","paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid","paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/postcontract"}],"panels":[]}]},"httpPath":"/foreignExchange/contract"},{"label":"Activate or cancel contract","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/putcontract","routeSlug":"/products/fx/openapi/other/putcontract","metadata":{"seo":{"title":"Activate or cancel contract","description":"Enable a contract to use locked in FX rates in an Account Payout. For Account Payouts customers only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putContract","name":"Activate or cancel contract","isWebhook":false,"pointer":"/paths/~1foreignExchange~1contract~1{contractId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate or cancel contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable a contract to use locked in FX rates in an Account Payout. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Account Payouts customers only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contractId","in":"path","schemaId":"schema_396","description":"Unique ID of the contract.","required":true,"example":"C000000001"}],"pointer":"/paths/~1foreignExchange~1contract~1{contractId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_393","required":true},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_394","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1foreignExchange~1contract~1{contractId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeSchemas":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/putActivatedContractItems","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Activate contract","paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Cancel contract"]}},"schemaId":"components/schemas/putActivatedContractItems","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Activate contract","paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Cancel contract"],"pointer":"/paths/~1foreignExchange~1contract~1{contractId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/foreignExchange/contract/{contractId}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"contractId","in":"path","required":true,"example":"C000000001","schemaId":"schema_396"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.worldpay.foreignexchange-v1+json","schemaId":"schema_393"},{"name":"WP-CorrelationId","in":"header","required":false,"example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_394"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/putActivatedContractItems","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Activate contract","paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Cancel contract"]}},"responseCodes":["204","400","401","403","404","409","500"],"pointer":"/foreignExchange/contract/{contractId}","href":"other/putcontract","openApiOperationId":"putContract","summary":"Activate or cancel contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/putActivatedContractItems","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Activate contract","paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Cancel contract"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeSchemas":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/putActivatedContractItems","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Activate contract","paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Cancel contract"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK response if the request is valid"},{"code":"400","description":"BAD REQUEST response if the status of the contract is not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/status is not correct"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/status is not correct"]},{"code":"401","description":"UNAUTHORIZED response if credentials are invalid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]},{"code":"403","description":"FORBIDDEN response if Entitlements are not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]},{"code":"404","description":"NOT FOUND response","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]},{"code":"409","description":"CONFLICT response","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/409/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/when a contract is re-activated or re-cancelled"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/409/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/when a contract is re-activated or re-cancelled"]},{"code":"500","description":"Internal server error","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}],"pointer":"/paths/~1foreignExchange~1contract~1{contractId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/status is not correct"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/status is not correct"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/409/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/when a contract is re-activated or re-cancelled"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/409/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/when a contract is re-activated or re-cancelled"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1contract~1{contractId}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/putcontract"}],"panels":[]}]},"httpPath":"/foreignExchange/contract/{contractId}"},{"label":"Add a markup to your FX rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/addmarkup","routeSlug":"/products/fx/openapi/other/addmarkup","metadata":{"seo":{"title":"Add a markup to your FX rate","description":"Adding a markup to an existing FX rate. For MCP customers only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addMarkup","name":"Add a markup to your FX rate","isWebhook":false,"pointer":"/paths/~1foreignExchange~1markup~1{entity}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a markup to your FX rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adding a markup to an existing FX rate. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For MCP customers only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_394","description":"MCP Account Identifier (PartyID- Merchant Company ID, unique 6-digit ID given to you during the onboarding process) for which rates should be retrieved.","required":true,"example":"100001"}],"pointer":"/paths/~1foreignExchange~1markup~1{entity}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_393","required":true},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_394","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1foreignExchange~1markup~1{entity}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeSchemas":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/putMarkupRequestItems","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Add a markup"]}},"schemaId":"components/schemas/putMarkupRequestItems","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Add a markup"],"pointer":"/paths/~1foreignExchange~1markup~1{entity}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/foreignExchange/markup/{entity}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"example":"100001","schemaId":"schema_394"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.worldpay.foreignexchange-v1+json","schemaId":"schema_393"},{"name":"WP-CorrelationId","in":"header","required":false,"example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_394"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/putMarkupRequestItems","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Add a markup"]}},"responseCodes":["204","401","403","404","500"],"pointer":"/foreignExchange/markup/{entity}","href":"other/addmarkup","openApiOperationId":"addMarkup","summary":"Add a markup to your FX rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/putMarkupRequestItems","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Add a markup"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeSchemas":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/putMarkupRequestItems","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Add a markup"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK response if the request is valid"},{"code":"401","description":"UNAUTHORIZED response if credentials are invalid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]},{"code":"403","description":"FORBIDDEN response if Entitlements are not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]},{"code":"404","description":"NOT FOUND response","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]},{"code":"500","description":"Internal server error","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}],"pointer":"/paths/~1foreignExchange~1markup~1{entity}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/addmarkup"}],"panels":[]}]},"httpPath":"/foreignExchange/markup/{entity}"},{"label":"Retrieve markup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/fx/openapi/other/getmarkup","routeSlug":"/products/fx/openapi/other/getmarkup","metadata":{"seo":{"title":"Retrieve markup","description":"Retrieving an existing markup for a specific FX rate.For MCP customers only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMarkup","name":"Retrieve markup","isWebhook":false,"pointer":"/paths/~1foreignExchange~1markup~1{entity}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve markup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieving an existing markup for a specific FX rate."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For MCP customers only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_395","description":"MCP Account Identifier (PartyID- Merchant Company ID, unique 6-digit ID given to you during the onboarding process.) for which rates should be retrieved.","required":true,"example":"100001"}],"pointer":"/paths/~1foreignExchange~1markup~1{entity}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sourceCurrency","in":"query","schemaId":"schema_392","description":"The transaction currency code. If not supplied, the response contains rates for all source currencies against the target currency.","example":"USD"},{"name":"targetCurrency","in":"query","schemaId":"schema_392","description":"Your funding (settlement) currency code. If not supplied, the response contains rates for all target currencies against the source currency.","example":"EUR"}],"pointer":"/paths/~1foreignExchange~1markup~1{entity}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_393","required":true},{"name":"WP-CorrelationId","in":"header","schemaId":"schema_394","description":"Optional ID to trace requests, if not provided, it is generated.","example":"15cd16b2-7b82-41cb-9b11-21be9dacad88"}],"pointer":"/paths/~1foreignExchange~1markup~1{entity}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/foreignExchange/markup/{entity}","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"example":"100001","schemaId":"schema_395"}],"query":[{"name":"sourceCurrency","in":"query","required":false,"example":"USD","schemaId":"components/schemas/CurrencyCode"},{"name":"targetCurrency","in":"query","required":false,"example":"EUR","schemaId":"components/schemas/CurrencyCode"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.worldpay.foreignexchange-v1+json","schemaId":"schema_393"},{"name":"WP-CorrelationId","in":"header","required":false,"example":"15cd16b2-7b82-41cb-9b11-21be9dacad88","schemaId":"schema_394"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/foreignExchange/markup/{entity}","href":"other/getmarkup","openApiOperationId":"getMarkup","summary":"Retrieve markup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK response if the request is valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ExternalGetMarkupResponse"}},"schemaId":"components/schemas/ExternalGetMarkupResponse"},{"code":"401","description":"UNAUTHORIZED response if credentials are invalid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]},{"code":"403","description":"FORBIDDEN response if Entitlements are not valid","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]},{"code":"404","description":"NOT FOUND response","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]},{"code":"500","description":"Internal server error","mediaType":"application/vnd.worldpay.foreignexchange-v1+json","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}],"pointer":"/paths/~1foreignExchange~1markup~1{entity}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalGetMarkupResponse","mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ExternalGetMarkupResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"],"mediaTypes":["application/vnd.worldpay.foreignexchange-v1+json"],"mediaTypeContent":{"application/vnd.worldpay.foreignexchange-v1+json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1foreignExchange~1markup~1{entity}/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/getmarkup"}],"panels":[]}]},"httpPath":"/foreignExchange/markup/{entity}"}],"store":{"schemaStore":{"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]*$"}},"components/schemas/postCreateContractItems":{"id":"components/schemas/postCreateContractItems","kind":"json-schema","title":"postCreateContractItems","data":{"required":["effectiveDate","sourceCurrency","targetCurrency","targetAmount","entity"],"type":"object","properties":{"effectiveDate":{"description":"A future date when the contract becomes available and can be used. Date must be within 30 days in the future.","example":"2025-12-31T00:00:00.000Z","type":"string"},"sourceCurrency":{"description":"The transaction currency code. If not supplied, the response contains rates for all source currencies against the target currency.","example":"USD"},"targetCurrency":{"description":"Your funding (settlement) currency code. If not supplied, the response contains rates for all target currencies against the source currency.","example":"EUR"},"targetAmount":{"description":"The total amount for your forward FX contract and future payout request in the targetCurrency.","example":1.23},"entity":{"description":"6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process","example":"100001"},"customerReference":{"description":"A reference generated by you representing the payer who funds the FX contract.","example":"Customer 001","maxLength":35}}}},"components/schemas/postCreateQuoteItems":{"id":"components/schemas/postCreateQuoteItems","kind":"json-schema","title":"postCreateQuoteItems","data":{"required":["entity","intent","sourceCurrency","targetCurrency"],"type":"object","properties":{"entity":{"description":"6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process","example":"100001","type":"string"},"intent":{"description":"Transaction type (intention) for which rates should be retrieved.","type":"string","enum":["PAYOUT","FX DEAL","MULTI-CURRENCY PRICING","CONSUMER RATES","PAYOUT LIVE RATE"]},"sourceCurrency":{"description":"The debit currency.","example":"USD","type":"string"},"targetCurrency":{"description":"The credit currency.","example":"EUR","type":"string"}}}},"components/schemas/putActivatedContractItems":{"id":"components/schemas/putActivatedContractItems","kind":"json-schema","title":"putActivatedContractItems","data":{"required":["status","entity"],"type":"object","properties":{"status":{"description":"New status of the contract.","enum":["ACTIVE","CANCELLED"],"type":"string"},"entity":{"description":"6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process","example":"100001","type":"string"}}}},"components/schemas/putMarkupRequestItems":{"id":"components/schemas/putMarkupRequestItems","kind":"json-schema","title":"putMarkupRequestItems","data":{"required":["sourceCurrency","targetCurrency","markup"],"type":"object","properties":{"sourceCurrency":{"description":"The transaction currency code. If not supplied, the response contains rates for all source currencies against the target currency.","example":"AUD"},"targetCurrency":{"description":"Your funding (settlement) currency code. If not supplied, the response contains rates for all target currencies against the source currency.","example":"GBP"},"markup":{"description":"The additional margin percentage set up on FX rates.","example":1.23}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"description":"The unique error name","type":"string"},"message":{"description":"Error description message","type":"string"}}}},"components/schemas/ExternalRateResponse":{"id":"components/schemas/ExternalRateResponse","kind":"json-schema","title":"ExternalRateResponse","data":{"type":"object","properties":{"rates":{"description":"A collection of rates items.","type":"array","items":{"$ref":"#/components/schemas/ExternalRateItems"}}}}},"components/schemas/ErrorResponse400":{"id":"components/schemas/ErrorResponse400","kind":"json-schema","title":"ErrorResponse400","data":{"type":"object","required":["validationErrors","errorName","message"],"properties":{"validationErrors":{"description":"Object containing details of validation errors occurred","type":"array","items":{"$ref":"#/components/schemas/ErrorResponse400Item"}},"errorName":{"description":"The unique error name","type":"string"},"message":{"description":"Error description message","type":"string"}}}},"components/schemas/ExternalRateItems":{"id":"components/schemas/ExternalRateItems","kind":"json-schema","title":"ExternalRateItems","data":{"type":"object","properties":{"rateId":{"description":"Unique reference for the rate.","type":"string","nullable":false,"example":"R12345678"},"intent":{"description":"Transaction type (intention) for which rates should be retrieved.","type":"string","nullable":false,"example":"PAYOUT"},"sourceCurrency":{"description":"The debit currency.","type":"string","example":"EUR"},"targetCurrency":{"description":"The credit currency.","type":"string","nullable":false,"example":"GBP"},"bidRate":{"description":"The buy/refund rate for the currency pairing.","type":"number","format":"double","nullable":false,"example":1.23456789},"askRate":{"description":"The sell/purchase rate for the currency pairing.","type":"number","format":"double","nullable":false,"example":1.23456789},"entity":{"description":"6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process.","type":"string","nullable":false,"example":100001},"issuedDate":{"description":"The posting date of the specific statement item.","type":"string","format":"date-time","nullable":false,"example":"2025-01-01T12:00:00.000Z"},"validFrom":{"description":"Validation date from.","type":"string","format":"date-time","nullable":false,"example":"2025-01-10T12:00:00.000Z"},"validTo":{"description":"Validation date to.","type":"string","format":"date-time","nullable":false,"example":"2025-01-10T12:00:00.000Z"}}}},"components/schemas/ErrorResponse400Item":{"id":"components/schemas/ErrorResponse400Item","kind":"json-schema","title":"ErrorResponse400Item","data":{"type":"object","required":["queryParameter","errorName","message"],"properties":{"queryParameter":{"description":"Parameter for which the error occurred","type":"string"},"errorName":{"description":"Unique name of the validation error","type":"string"},"message":{"description":"Error description message","type":"string"}}}},"components/schemas/ErrorResponse400Quote":{"id":"components/schemas/ErrorResponse400Quote","kind":"json-schema","title":"ErrorResponse400Quote","data":{"type":"object","required":["validationErrors","errorName","message"],"properties":{"validationErrors":{"description":"Object containing details of validation errors occurred","type":"array","items":{"$ref":"#/components/schemas/ErrorResponse400QuoteItem"}},"errorName":{"description":"The unique error name","type":"string"},"message":{"description":"Error description message","type":"string"}}}},"components/schemas/ErrorResponse400QuoteItem":{"id":"components/schemas/ErrorResponse400QuoteItem","kind":"json-schema","title":"ErrorResponse400QuoteItem","data":{"type":"object","required":["jsonPath","errorName","message"],"properties":{"jsonPath":{"description":"Parameter for which the error occurred","type":"string"},"errorName":{"description":"Unique name of the validation error","type":"string"},"message":{"description":"Error description message","type":"string"}}}},"components/schemas/ErrorResponse400Contract":{"id":"components/schemas/ErrorResponse400Contract","kind":"json-schema","title":"ErrorResponse400Contract","data":{"type":"object","required":["errorName","message"],"properties":{"errorName":{"description":"The unique error name","type":"string"},"message":{"description":"Error description message","type":"string"}}}},"components/schemas/ExternalPostQuoteResponse":{"id":"components/schemas/ExternalPostQuoteResponse","kind":"json-schema","title":"ExternalPostQuoteResponse","data":{"type":"object","properties":{"entity":{"description":"6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process.","type":"string","nullable":false,"example":"100001"},"intent":{"description":"Transaction type (intention) for which rates should be retrieved.","type":"string","nullable":false,"example":"PAYOUT"},"quote":{"description":"A collection of account statement items.","type":"object","properties":{"quoteId":{"description":"Unique quote id.","type":"string","nullable":false,"example":"Q000000001"},"sourceCurrency":{"description":"The debit currency.","type":"string","nullable":false,"example":"EUR"},"targetCurrency":{"description":"The credit currency.","type":"string","nullable":false,"example":"GBP"},"rateId":{"description":"Unique rate id.","type":"string","nullable":false,"example":"12345678"},"rate":{"description":"Rate amount.","type":"string","nullable":false,"example":"1.2345"},"quoteExpiryTime":{"description":"Quote expiry time.","type":"string","nullable":false,"example":"2025-01-10T12:00:00.000Z"}}}}}},"components/schemas/ExternalGetQuoteResponse":{"id":"components/schemas/ExternalGetQuoteResponse","kind":"json-schema","title":"ExternalGetQuoteResponse","data":{"type":"object","properties":{"entity":{"description":"6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process.","type":"string","nullable":false,"example":"100001"},"intent":{"description":"Transaction type (intention) for which rates should be retrieved.","type":"string","nullable":false,"example":"PAYOUT"},"quote":{"description":"A collection of quote items.","type":"object","properties":{"quoteId":{"description":"Unique quote id.","type":"string","nullable":false,"example":"Q000000001"},"sourceCurrency":{"description":"The debit currency.","type":"string","nullable":false,"example":"EUR"},"targetCurrency":{"description":"The credit currency.","type":"string","nullable":false,"example":"GBP"},"rateId":{"description":"Unique rate id.","type":"string","nullable":false,"example":"12345678"},"rate":{"description":"Rate amount.","type":"string","nullable":false,"example":"1.2345"},"quoteExpiryTime":{"description":"Quote expiry time.","type":"string","nullable":false,"example":"2025-01-10T12:00:00.000Z"}}}}}},"components/schemas/ExternalGetMarkupResponse":{"id":"components/schemas/ExternalGetMarkupResponse","kind":"json-schema","title":"ExternalGetMarkupResponse","data":{"type":"object","properties":{"sourceCurrency":{"description":"The debit currency.","type":"string","nullable":false,"example":"EUR"},"targetCurrency":{"description":"The credit currency.","type":"string","nullable":false,"example":"GBP"},"paymentMethod":{"description":"Payment method.","type":"string","nullable":false,"example":"ENDCONSUMERRATES"},"entity":{"description":"6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process.","type":"string","nullable":false,"example":"100001"},"value":{"description":"Markup value setup.","type":"string","nullable":false,"example":"1.234"}}}},"components/schemas/ExternalPostContractResponse":{"id":"components/schemas/ExternalPostContractResponse","kind":"json-schema","title":"ExternalPostContractResponse","data":{"type":"object","properties":{"contractId":{"description":"Unique ID of the contract.","type":"string","nullable":false,"example":"C000000001"},"targetAmount":{"description":"Crediting currency code.","type":"string","nullable":false,"example":"EUR"},"sourceAmount":{"description":"Debiting currency code.","type":"string","nullable":false,"example":"GBP"},"status":{"description":"Status of the contract.","type":"string","nullable":false,"example":"PENDING"},"effectiveDate":{"description":"Datetime representation in UTC of when the contract starts.","type":"string","nullable":false,"example":"2025-01-01T00:00:00.000Z"},"customerReference":{"description":"A reference generated by you representing the payer who funds the FX contract.","type":"string","nullable":true,"example":"Customer 001"},"quote":{"description":"A collection of quote items.","type":"object","properties":{"quoteId":{"description":"Unique quote id.","type":"string","nullable":false,"example":"F000000001"},"sourceCurrency":{"description":"The debit currency.","type":"string","nullable":false,"example":"EUR"},"targetCurrency":{"description":"The credit currency.","type":"string","nullable":false,"example":"GBP"},"entity":{"description":"6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process.","type":"string","nullable":false,"example":"100001"},"intent":{"description":"Payment method (intent) for which rates are retrieved.","type":"string","nullable":false,"example":"FORWARD FX"},"rateId":{"description":"Unique rate id.","type":"string","nullable":false,"example":"1234567"},"rate":{"description":"Rate amount.","type":"string","nullable":false,"example":"1.23456"},"quoteExpiryTime":{"description":"Quote expiry time.","type":"string","nullable":false,"example":"2025-01-01T23:59:59.999Z"}}}}}},"schema_390":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":50,"enum":["PAYOUT","FX DEAL","MULTI-CURRENCY PRICING","CONSUMER RATES","PAYOUT LIVE RATE"]},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"type":"string","minLength":6,"maxLength":6},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CurrencyCode","minLength":3,"maxLength":3},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"type":"string","example":"application/vnd.worldpay.foreignexchange-v1+json"},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"type":"string"},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"type":"string","maxLength":6},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":50},"id":"schema_396"}},"exampleStore":{"paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not correct":{"value":{"validationErrors":[{"queryParameter":"Intent","errorName":"fieldHasInvalidValue","message":"Intent is not valid for the current Consumer."}],"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid"},"key":"intent is not correct","summary":"intent is not correct","id":"paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not correct"},"paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid":{"value":{"validationErrors":[{"queryParameter":"SourceCurrency","errorName":"fieldHasInvalidValue","message":"Invalid SourceCurrency value."}],"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid"},"key":"source currency is not valid","summary":"source currency is not valid","id":"paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid"},"paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid":{"value":{"validationErrors":[{"queryParameter":"TargetCurrency","errorName":"fieldHasInvalidValue","message":"Invalid TargetCurrency value"}],"errorName":"urlContainsInvalidValue","message":"The URL contains a value or values that are invalid"},"key":"target currency is not valid","summary":"target currency is not valid","id":"paths/~1foreignExchange~1rates/get/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"},"paths/~1foreignExchange~1rates/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized":{"value":{"errorName":"unauthorizedRequest","message":"The request is unauthorized"},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1foreignExchange~1rates/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"},"paths/~1foreignExchange~1rates/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden":{"value":{"errorName":"forbidden","message":""},"key":"forbidden","summary":"forbidden","id":"paths/~1foreignExchange~1rates/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"},"paths/~1foreignExchange~1rates/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound":{"value":{"errorName":"notFound","message":"No rates found"},"key":"pageNotFound","summary":"pageNotFound","id":"paths/~1foreignExchange~1rates/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"},"paths/~1foreignExchange~1rates/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example":{"value":{"errorName":"internalErrorOccurred","message":"Something went wrong"},"id":"paths/~1foreignExchange~1rates/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"},"paths/~1foreignExchange~1quote/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new quote":{"value":{"entity":"100001","intent":"PAYOUT","sourceCurrency":"USD","targetCurrency":"EUR"},"key":"Create a new quote","summary":"Create a new quote","id":"paths/~1foreignExchange~1quote/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new quote"},"paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not valid":{"value":{"validationErrors":[{"jsonPath":"Intent","errorName":"fieldHasInvalidValue","message":"Missing Intent value."}],"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema"},"key":"intent is not valid","summary":"intent is not valid","id":"paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/intent is not valid"},"paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid":{"value":{"validationErrors":[{"jsonPath":"SourceCurrency","errorName":"fieldHasInvalidValue","message":"Invalid SourceCurrency value."}],"errorName":"urlContainsInvalidValue","message":"The json body provided does not match the expected schema"},"key":"source currency is not valid","summary":"source currency is not valid","id":"paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid"},"paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid":{"value":{"validationErrors":[{"jsonPath":"TargetCurrency","errorName":"fieldHasInvalidValue","message":"Invalid TargetCurrency value."}],"errorName":"urlContainsInvalidValue","message":"The json body provided does not match the expected schema"},"key":"target currency is not valid","summary":"target currency is not valid","id":"paths/~1foreignExchange~1quote/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"},"paths/~1foreignExchange~1quote/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized":{"value":{"errorName":"unauthorizedRequest","message":"The request is unauthorized"},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1foreignExchange~1quote/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"},"paths/~1foreignExchange~1quote/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden":{"value":{"errorName":"forbidden","message":""},"key":"forbidden","summary":"forbidden","id":"paths/~1foreignExchange~1quote/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"},"paths/~1foreignExchange~1quote/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound":{"value":{"errorName":"notFound","message":"No rate found for given input"},"key":"pageNotFound","summary":"pageNotFound","id":"paths/~1foreignExchange~1quote/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"},"paths/~1foreignExchange~1quote/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example":{"value":{"errorName":"internalErrorOccurred","message":"Something went wrong"},"id":"paths/~1foreignExchange~1quote/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"},"paths/~1foreignExchange~1quote/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized":{"value":{"errorName":"unauthorizedRequest","message":"The request is unauthorized"},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1foreignExchange~1quote/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"},"paths/~1foreignExchange~1quote/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden":{"value":{"errorName":"forbidden","message":""},"key":"forbidden","summary":"forbidden","id":"paths/~1foreignExchange~1quote/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"},"paths/~1foreignExchange~1quote/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound":{"value":{"errorName":"notFound","message":"Quote for given input does not exist"},"key":"pageNotFound","summary":"pageNotFound","id":"paths/~1foreignExchange~1quote/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"},"paths/~1foreignExchange~1quote/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example":{"value":{"errorName":"internalErrorOccurred","message":"Something went wrong"},"id":"paths/~1foreignExchange~1quote/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"},"paths/~1foreignExchange~1contract/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new contract":{"value":{"effectiveDate":"2025-12-31","sourceCurrency":"USD","targetCurrency":"EUR","targetAmount":1.23,"entity":"100001","customerReference":"Customer 001"},"key":"Create a new contract","summary":"Create a new contract","id":"paths/~1foreignExchange~1contract/post/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Create a new contract"},"paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/EffectiveDate is longer than 30 days":{"value":{"validationErrors":[{"jsonPath":"EffectiveDate","errorName":"fieldHasInvalidValueg","message":"EffectiveDate must be within the next 30 days."}],"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema"},"key":"EffectiveDate is longer than 30 days","summary":"EffectiveDate is longer than 30 days","id":"paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/EffectiveDate is longer than 30 days"},"paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid":{"value":{"validationErrors":[{"jsonPath":"SourceCurrency","errorName":"fieldHasInvalidValueg","message":"Invalid SourceCurrency value."}],"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema"},"key":"source currency is not valid","summary":"source currency is not valid","id":"paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/source currency is not valid"},"paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid":{"value":{"validationErrors":[{"jsonPath":"TargetCurrency","errorName":"fieldHasInvalidValue","message":"Invalid TargetCurrency value."}],"errorName":"bodyDoesNotMatchSchema","message":"The json body provided does not match the expected schema"},"key":"target currency is not valid","summary":"target currency is not valid","id":"paths/~1foreignExchange~1contract/post/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/target currency is not valid"},"paths/~1foreignExchange~1contract/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized":{"value":{"errorName":"unauthorizedRequest","message":"The request is unauthorized"},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1foreignExchange~1contract/post/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"},"paths/~1foreignExchange~1contract/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden":{"value":{"errorName":"forbidden","message":""},"key":"forbidden","summary":"forbidden","id":"paths/~1foreignExchange~1contract/post/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"},"paths/~1foreignExchange~1contract/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound":{"value":{"errorName":"notFound","message":"Not found"},"key":"pageNotFound","summary":"pageNotFound","id":"paths/~1foreignExchange~1contract/post/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"},"paths/~1foreignExchange~1contract/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example":{"value":{"errorName":"internalErrorOccurred","message":"Something went wrong"},"id":"paths/~1foreignExchange~1contract/post/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"},"paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Activate contract":{"value":{"status":"ACTIVE","entity":"100001"},"key":"Activate contract","summary":"Activate contract","id":"paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Activate contract"},"paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Cancel contract":{"value":{"status":"CANCELLED","entity":"100001"},"key":"Cancel contract","summary":"Cancel contract","id":"paths/~1foreignExchange~1contract~1{contractId}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Cancel contract"},"paths/~1foreignExchange~1contract~1{contractId}/put/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/status is not correct":{"value":{"errorName":"invalidInput","message":"The input received is not valid"},"key":"status is not correct","summary":"status is not correct","id":"paths/~1foreignExchange~1contract~1{contractId}/put/responses/400/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/status is not correct"},"paths/~1foreignExchange~1contract~1{contractId}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized":{"value":{"errorName":"unauthorizedRequest","message":"The request is unauthorized"},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1foreignExchange~1contract~1{contractId}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"},"paths/~1foreignExchange~1contract~1{contractId}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden":{"value":{"errorName":"forbidden","message":""},"key":"forbidden","summary":"forbidden","id":"paths/~1foreignExchange~1contract~1{contractId}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"},"paths/~1foreignExchange~1contract~1{contractId}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound":{"value":{"errorName":"notFound","message":"Quote for given input does not exist"},"key":"pageNotFound","summary":"pageNotFound","id":"paths/~1foreignExchange~1contract~1{contractId}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"},"paths/~1foreignExchange~1contract~1{contractId}/put/responses/409/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/when a contract is re-activated or re-cancelled":{"value":{"errorName":"conflict","message":"Current status of the contract is invalid for requested transition"},"key":"when a contract is re-activated or re-cancelled","summary":"when a contract is re-activated or re-cancelled","id":"paths/~1foreignExchange~1contract~1{contractId}/put/responses/409/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/when a contract is re-activated or re-cancelled"},"paths/~1foreignExchange~1contract~1{contractId}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example":{"value":{"errorName":"internalErrorOccurred","message":"Something went wrong"},"id":"paths/~1foreignExchange~1contract~1{contractId}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"},"paths/~1foreignExchange~1markup~1{entity}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Add a markup":{"value":{"sourceCurrency":"AUD","targetCurrency":"GBP","markup":1.23},"key":"Add a markup","summary":"Add a markup","id":"paths/~1foreignExchange~1markup~1{entity}/put/requestBody/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Add a markup"},"paths/~1foreignExchange~1markup~1{entity}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized":{"value":{"errorName":"unauthorizedRequest","message":"The request is unauthorized"},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1foreignExchange~1markup~1{entity}/put/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"},"paths/~1foreignExchange~1markup~1{entity}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden":{"value":{"errorName":"forbidden","message":""},"key":"forbidden","summary":"forbidden","id":"paths/~1foreignExchange~1markup~1{entity}/put/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"},"paths/~1foreignExchange~1markup~1{entity}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound":{"value":{"errorName":"notFound","message":"Not found"},"key":"pageNotFound","summary":"pageNotFound","id":"paths/~1foreignExchange~1markup~1{entity}/put/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"},"paths/~1foreignExchange~1markup~1{entity}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example":{"value":{"errorName":"internalErrorOccurred","message":"Something went wrong"},"id":"paths/~1foreignExchange~1markup~1{entity}/put/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"},"paths/~1foreignExchange~1markup~1{entity}/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized":{"value":{"errorName":"unauthorizedRequest","message":"The request is unauthorized"},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1foreignExchange~1markup~1{entity}/get/responses/401/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/Unauthorized"},"paths/~1foreignExchange~1markup~1{entity}/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden":{"value":{"errorName":"forbidden","message":""},"key":"forbidden","summary":"forbidden","id":"paths/~1foreignExchange~1markup~1{entity}/get/responses/403/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/forbidden"},"paths/~1foreignExchange~1markup~1{entity}/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound":{"value":{"errorName":"notFound","message":"Not found"},"key":"pageNotFound","summary":"pageNotFound","id":"paths/~1foreignExchange~1markup~1{entity}/get/responses/404/content/application~1vnd.worldpay.foreignexchange-v1+json/examples/pageNotFound"},"paths/~1foreignExchange~1markup~1{entity}/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example":{"value":{"errorName":"internalErrorOccurred","message":"Something went wrong"},"id":"paths/~1foreignExchange~1markup~1{entity}/get/responses/500/content/application~1vnd.worldpay.foreignexchange-v1+json/example"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try) - Account Payouts customers only"},{"url":"https://access.worldpay.com","description":"Live"}],"specType":"openapi"},"options":{"jsonSamplesExpandLevel":7,"schemasExpansionLevel":1,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideInfoMetadata":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"Python"},{"lang":"Java"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"PHP"},{"lang":"Ruby"},{"lang":"C#"}]},"feedback":{"type":"sentiment","settings":{"label":"Do you like our page?","submitText":"Thanks for your feedback","comment":{"likeLabel":"What was most helpful?","dislikeLabel":"What can we improve?"}}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/access/_bundle/products/fx/@v1/openapi.json?download"},{"url":"/access/_bundle/products/fx/@v1/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"FX","description":"Manage Foreign Exchange.\n\n__Authentication header__\n\n  ```\n    Authorization: {your_credentials}\n  ```\n  Replace `{your_credentials}` with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.\n  <br /> <br />\n  You **must** use the `Authorization` header for any request you send to our FX APIs.\n  <br /><br />\n  __Accept header__\n  ```\n    Accept: application/vnd.worldpay.foreignexchange-v1+json\n  ```\n\nWe use the Accept header to identify which version of our API you are using.\nYou must use the Accept header for any request you send to our FX APIs.\n\n<br /><br />\n__DNS whitelisting__\n\n\nWhitelist the following URLs:\n\n* `https://try.access.worldpay.com/` - Account Payouts customers only\n\n* `https://access.worldpay.com/` - MCP and Account Payouts customers\n\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting. When\nyou make a request within Access Worldpay, you should always cache the\nresponse returned.","catalog-list":true,"business":["Enterprise","Marketplaces"],"category":["FX"],"generated":true}},"baseSlug":"/products/fx/openapi","routesMapping":{}}