{"items":[{"type":"link","label":"Hosted Payment Pages (HPP) API","link":"/products/hosted-payment-pages/openapi","routeSlug":"/products/hosted-payment-pages/openapi","content":{"contentType":"overview","meta":{"name":"Hosted Payment Pages (HPP) API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/access/_bundle/products/hosted-payment-pages/@v1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/access/_bundle/products/hosted-payment-pages/@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":[{"description":"Test (Try)","url":"https://try.access.worldpay.com"},{"description":"Live","url":"https://access.worldpay.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Hosted Payment Pages (HPP) API (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":"Our low-code integration to take payments securely."},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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 Hosted Payment Pages APIs."},"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":"Accept header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  Accept: application/vnd.worldpay.payment_pages-v1.hal+json\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  Accept: application/vnd.worldpay.payment_pages-v1.hal+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. You must use the Accept header for any request you send to our Hosted Payment Pages 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":"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":"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":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://try.access.worldpay.com/"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://access.worldpay.com/"},"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."},"children":[]}]}]}]}],"sectionId":"/products/hosted-payment-pages/openapi"}],"sectionId":"/products/hosted-payment-pages/openapi"}]}]}},{"label":"Create a new transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/hosted-payment-pages/openapi/other/create","routeSlug":"/products/hosted-payment-pages/openapi/other/create","metadata":{"seo":{"title":"Create a new transaction","description":"Create a new transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create","name":"Create a new transaction","isWebhook":false,"pointer":"/paths/~1payment_pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"BasicAuth"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"WP-CorrelationId","in":"header","schemaId":"schema_397","description":"Used to identify individual requests made to our API.","required":true},{"name":"User-Agent","in":"header","schemaId":"schema_398","description":"The name of the client calling the API."}],"pointer":"/paths/~1payment_pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.worldpay.payment_pages-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border bank account max fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (domestic)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum email)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (stored value)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest card payment (using customisation_id)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Request 3DS and FraudSight off","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (mandatory fields)"]}},"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border bank account max fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (domestic)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum email)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (stored value)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest card payment (using customisation_id)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Request 3DS and FraudSight off","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (mandatory fields)"],"pointer":"/paths/~1payment_pages/post/requestBody","description":"The transaction to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment_pages","servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"WP-CorrelationId","in":"header","required":true,"schemaId":"schema_397"},{"name":"User-Agent","in":"header","required":false,"schemaId":"schema_398"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"BasicAuth"}],"scopes":[]}],"requestBody":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border bank account max fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (domestic)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum email)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (stored value)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest card payment (using customisation_id)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Request 3DS and FraudSight off","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (mandatory fields)"]}},"responseCodes":["200","400","401","500"],"pointer":"/payment_pages","href":"other/create","openApiOperationId":"create","summary":"Create a new transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"url":"https://access.worldpay.com","description":"Live"}],"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border bank account max fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (domestic)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum email)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (stored value)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest card payment (using customisation_id)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Request 3DS and FraudSight off","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (mandatory fields)"],"mediaTypes":["application/vnd.worldpay.payment_pages-v1.hal+json"],"mediaTypeSchemas":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border bank account max fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (domestic)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum email)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (stored value)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest card payment (using customisation_id)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Request 3DS and FraudSight off","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (mandatory fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (all fields)","paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (mandatory fields)"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transaction creation was successful","mediaType":"application/vnd.worldpay.payment_pages-v1.hal+json","mediaTypes":["application/vnd.worldpay.payment_pages-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/SuccessfulCreateTransactionResponse","exampleIds":["paths/~1payment_pages/post/responses/200/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Successful response"]}},"schemaId":"components/schemas/SuccessfulCreateTransactionResponse","exampleIds":["paths/~1payment_pages/post/responses/200/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Successful response"]},{"code":"400","description":"Bad request","mediaType":"application/vnd.worldpay.payment_pages-v1.hal+json","mediaTypes":["application/vnd.worldpay.payment_pages-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/400/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Invalid request response"]}},"schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/400/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Invalid request response"]},{"code":"401","description":"Unauthorized","mediaType":"application/vnd.worldpay.payment_pages-v1.hal+json","mediaTypes":["application/vnd.worldpay.payment_pages-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/401/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Unauthorized response"]}},"schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/401/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Unauthorized response"]},{"code":"500","description":"Internal server error","mediaType":"application/vnd.worldpay.payment_pages-v1.hal+json","mediaTypes":["application/vnd.worldpay.payment_pages-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/500/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Internal error response"]}},"schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/500/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Internal error response"]}],"pointer":"/paths/~1payment_pages/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SuccessfulCreateTransactionResponse","exampleIds":["paths/~1payment_pages/post/responses/200/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Successful response"],"mediaTypes":["application/vnd.worldpay.payment_pages-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/SuccessfulCreateTransactionResponse","exampleIds":["paths/~1payment_pages/post/responses/200/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Successful response"]}}},{"code":"400","schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/400/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Invalid request response"],"mediaTypes":["application/vnd.worldpay.payment_pages-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/400/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Invalid request response"]}}},{"code":"401","schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/401/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Unauthorized response"],"mediaTypes":["application/vnd.worldpay.payment_pages-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/401/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Unauthorized response"]}}},{"code":"500","schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/500/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Internal error response"],"mediaTypes":["application/vnd.worldpay.payment_pages-v1.hal+json"],"mediaTypeContent":{"application/vnd.worldpay.payment_pages-v1.hal+json":{"schemaId":"components/schemas/AwpApiErrorResponse","exampleIds":["paths/~1payment_pages/post/responses/500/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Internal error response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/create"}],"panels":[]}]},"httpPath":"/payment_pages"}],"store":{"schemaStore":{"components/schemas/AwpApiErrorResponse":{"id":"components/schemas/AwpApiErrorResponse","kind":"json-schema","title":"AwpApiErrorResponse","data":{"type":"object","properties":{"errorName":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/BillingAddress":{"id":"components/schemas/BillingAddress","kind":"json-schema","title":"BillingAddress","data":{"type":"object","description":"An object containing the billing address information.","properties":{"address1":{"type":"string","description":"Address line 1.","maxLength":85,"minLength":0},"address2":{"type":"string","description":"Address line 2.","maxLength":85,"minLength":0},"address3":{"type":"string","description":"Address line 3.","maxLength":85,"minLength":0},"city":{"type":"string","description":"Address city.","maxLength":50,"minLength":0},"countryCode":{"type":"string","description":"The supported ISO 3166-1 alpha-2 country code."},"firstName":{"type":"string","description":"The customer's first name.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"The customer's last name.","maxLength":22,"minLength":1},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for all countries except the following: * IE"},"children":[]}]}]}],"maxLength":15,"minLength":0},"state":{"type":"string","description":"Address state or region.","maxLength":50,"minLength":0}}}},"components/schemas/Border":{"id":"components/schemas/Border","kind":"json-schema","title":"Border","data":{"type":"object","description":"Defines border styling options for elements on the payment page, including color, width, radius and style.","properties":{"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines border color in hex format. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"radius":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines border radius in pixels (0-30), must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"px"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"(([1-2]?[0-9])|30)px"},"style":{"type":"string","description":"Border style allowed values: solid, none, dotted, dashed, double.","maxLength":20,"minLength":0,"pattern":"solid|none|dotted|dashed|double"},"width":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines border width in pixels (0-10), must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"px"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"([0-9]|10)px"}}}},"components/schemas/Buttons":{"id":"components/schemas/Buttons","kind":"json-schema","title":"Buttons","data":{"type":"object","description":"Defines custom styling options for buttons on the HPP page. Including color, border and text styles","properties":{"backgroundColor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for background color. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"border":{"$ref":"#/components/schemas/Border"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for text color. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"fonts":{"$ref":"#/components/schemas/Fonts"}}}},"components/schemas/CancelOn":{"id":"components/schemas/CancelOn","kind":"json-schema","title":"CancelOn","data":{"type":"object","description":"Optional object to control skip auto-cancel behavior for CVC mismatch.","properties":{"cvcNotMatched":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to skip auto-cancel on CVC mismatch."},"children":[]}]}]}],"example":"disabled"}}}},"components/schemas/CreateToken":{"id":"components/schemas/CreateToken","kind":"json-schema","title":"CreateToken","data":{"type":"object","description":"An object that instructs us to create a token for the payment details supplied.","properties":{"description":{"type":"string","description":"A description of your token. If not supplied, a default description is created for you.  ","maxLength":255,"minLength":1,"pattern":"^([^&<]*)$"},"namespace":{"type":"string","description":"A namespace is used to group up to 16 cards, e.g. for one customer. A card can exist in more than one namespace.","maxLength":64,"minLength":1},"optIn":{"type":"string","description":"Used to choose how the customer could opt into their payment details being tokenized.\n\nSILENT - (default value) The card details are always saved (you must already have their consent to do this)\n\nNOTIFY - The card details are always saved (you must already have their consent to do this) and your customer will see this within our hosted payment pages\n\nASK - The card details are saved if your customer provides their consent. This adds a \"Save payment details\" tickbox to the page, which they tick to opt-in, or ignore to opt-out.\n","enum":["SILENT","NOTIFY","ASK"]},"type":{"type":"string","description":"The type of token to be created.","enum":["worldpay"]}},"required":["optIn","type"]}},"components/schemas/CustomerAgreement":{"id":"components/schemas/CustomerAgreement","kind":"json-schema","title":"CustomerAgreement","data":{"type":"object","description":"Contains specific customer agreements for the transaction. If this is present, then the creationToken must also be present.","properties":{"storedCardUsage":{"type":"string","description":"How the card is being used.","enum":["first","subsequent"],"x-enumDescriptions":{"first":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this when storing a card. Applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is \"cardOnFile\" or \"subscription\"."},"children":[]}]}]}],"subsequent":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this when taking payment with a previously stored card. Only applicable for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"cardOnFile\"."},"children":[]}]}]}]}},"type":{"type":"string","description":"The processing arrangement agreed with your customer.","enum":["subscription","cardOnFile"],"x-enumDescriptions":{"cardOnFile":"Use this for Cardholder Initiated Transactions (CITs).","subscription":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this where subsequent payments are processed without the cardholder being present aka Merchant Initiated Transactions (MITs). Subsequent payments must be submitted directly through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments/openapi"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"required":["storedCardUsage","type"]}},"components/schemas/Customisation":{"id":"components/schemas/Customisation","kind":"json-schema","title":"Customisation","data":{"type":"object","description":"Add CSS options for each payment to customize the look and feel of the payment page.","properties":{"backgroundColor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Background color for the payment page in hex format. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"buttons":{"$ref":"#/components/schemas/FocusableButtons"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text color for the payment page in hex format. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"fonts":{"$ref":"#/components/schemas/Fonts"},"inputs":{"$ref":"#/components/schemas/FocusableInputs"},"page":{"$ref":"#/components/schemas/Page"}}}},"components/schemas/FocusableButtons":{"id":"components/schemas/FocusableButtons","kind":"json-schema","title":"FocusableButtons","data":{"type":"object","description":"Defines hover and focus styling for buttons on the HPP page.","properties":{"backgroundColor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for background color. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"border":{"$ref":"#/components/schemas/Border"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for text color. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"focus":{"$ref":"#/components/schemas/Buttons"},"fonts":{"$ref":"#/components/schemas/Fonts"},"hover":{"$ref":"#/components/schemas/Buttons"}}}},"components/schemas/FocusableInputs":{"id":"components/schemas/FocusableInputs","kind":"json-schema","title":"FocusableInputs","data":{"type":"object","description":"Defines custom styling for input fields when hovered over or focused","properties":{"backgroundColor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for background color. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"border":{"$ref":"#/components/schemas/Border"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for text color. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"focus":{"$ref":"#/components/schemas/Inputs"},"fonts":{"$ref":"#/components/schemas/Fonts"},"hover":{"$ref":"#/components/schemas/Inputs"},"placeholder":{"$ref":"#/components/schemas/Placeholder"},"validation":{"$ref":"#/components/schemas/Validation"}}}},"components/schemas/Fonts":{"id":"components/schemas/Fonts","kind":"json-schema","title":"Fonts","data":{"type":"object","description":"Defines font styling options for text displayed on the payment pages, including the list of preferred font families.","properties":{"family":{"type":"array","description":"List of preferred font families for text on the payment page (e.g Arial, Times New Roman).","items":{"type":"string","description":"List of preferred font families for text on the payment page (e.g Arial, Times New Roman).","maxLength":50,"minLength":0},"maxItems":20,"minItems":0}}}},"components/schemas/Fraud":{"id":"components/schemas/Fraud","kind":"json-schema","title":"Fraud","data":{"type":"object","properties":{"type":{"type":"string","description":"You can use this to disable FraudSight for this request.","enum":["disabled"]}}}},"components/schemas/FundTransferAccount":{"id":"components/schemas/FundTransferAccount","kind":"json-schema","title":"FundTransferAccount","data":{"discriminator":{"mapping":{"bankAccount":"#/components/schemas/FundTransferAccountBank","card":"#/components/schemas/FundTransferAccountCard","email":"#/components/schemas/FundTransferAccountEmail","merchantWallet":"#/components/schemas/FundTransferAccountWallet","phone":"#/components/schemas/FundTransferAccountPhone","socialNetwork":"#/components/schemas/FundTransferAccountSocialNetwork","stagedDigitalWallet":"#/components/schemas/FundTransferAccountWallet","storedValueWallet":"#/components/schemas/FundTransferAccountWallet","wallet":"#/components/schemas/FundTransferAccountWallet"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/FundTransferAccountBank"},{"$ref":"#/components/schemas/FundTransferAccountCard"},{"$ref":"#/components/schemas/FundTransferAccountWallet"},{"$ref":"#/components/schemas/FundTransferAccountEmail"},{"$ref":"#/components/schemas/FundTransferAccountPhone"},{"$ref":"#/components/schemas/FundTransferAccountSocialNetwork"}]}},"components/schemas/FundTransferAccountBank":{"id":"components/schemas/FundTransferAccountBank","kind":"json-schema","title":"FundTransferAccountBank","data":{"type":"object","description":"Bank account details. identifierType determines which additional bank fields are required.","properties":{"accountNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account number of the recipient. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"routingNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"swift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]}]}]}],"maxLength":39,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s@!\\u00A3*#$)(\\-_=.,/;:'\"]*$"},"iban":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The International Bank Account Number (IBAN) of the recipient. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iban"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":34,"minLength":1,"pattern":"^[A-Za-z0-9]*$"},"identifierType":{"type":"string","description":"The identifier type for the bank account. This determines what additional information is required.","enum":["iban","swift","routingNumber","accountNumber"]},"routingNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ABA (American Bankers Association) Routing Transit Number (RTN). Identifies the Financial Institution of the recipient's account. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"routingNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":9,"minLength":9,"pattern":"^[0-9]*$"},"swiftBic":{"type":"string","description":"The SWIFT Bank Identification Code (BIC) of the recipient. Required if identifierType is swift. Must be either 8 or 11 alphanumeric characters.","maxLength":11,"minLength":8,"pattern":"^[A-Za-z0-9]*$"},"type":{"type":"string","description":"The type of account.","enum":["bankAccount"]}},"required":["identifierType","type"]}},"components/schemas/FundTransferAccountCard":{"id":"components/schemas/FundTransferAccountCard","kind":"json-schema","title":"FundTransferAccountCard","data":{"type":"object","description":"Card account details.","properties":{"cardNumber":{"type":"string","description":"Recipient's card number.","maxLength":19,"minLength":12,"pattern":"^[0-9]+$"},"type":{"type":"string","description":"The type of account.","enum":["card"]}},"required":["cardNumber","type"]}},"components/schemas/FundTransferAccountEmail":{"id":"components/schemas/FundTransferAccountEmail","kind":"json-schema","title":"FundTransferAccountEmail","data":{"type":"object","description":"Email account details.","properties":{"emailAddress":{"type":"string","description":"Recipient's email address.","maxLength":128,"minLength":1,"pattern":"^.+@.+$"},"type":{"type":"string","description":"The type of account.","enum":["email"]}},"required":["emailAddress","type"]}},"components/schemas/FundTransferAccountPhone":{"id":"components/schemas/FundTransferAccountPhone","kind":"json-schema","title":"FundTransferAccountPhone","data":{"type":"object","description":"Phone account details.","properties":{"phoneNumber":{"type":"string","description":"Recipient's phone number","maxLength":20,"minLength":4,"pattern":"^(?!\\s*$)[0-9\\s()+\\-/.x]*$"},"type":{"type":"string","description":"The type of account.","enum":["phone"]}},"required":["phoneNumber","type"]}},"components/schemas/FundTransferAccountSocialNetwork":{"id":"components/schemas/FundTransferAccountSocialNetwork","kind":"json-schema","title":"FundTransferAccountSocialNetwork","data":{"type":"object","description":"Social network account details.","properties":{"socialNetworkReference":{"type":"string","description":"A reference identifying recipient's social network account.","maxLength":50,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s@!\\u00A3*#$)(+\\-_=.,/;:'\"]*$"},"type":{"type":"string","description":"The type of account.","enum":["socialNetwork"]}},"required":["socialNetworkReference","type"]}},"components/schemas/FundTransferAccountWallet":{"id":"components/schemas/FundTransferAccountWallet","kind":"json-schema","title":"FundTransferAccountWallet","data":{"type":"object","description":"Wallet account details.","properties":{"type":{"type":"string","description":"The type of account.","enum":["wallet","storedValueWallet","stagedDigitalWallet","merchantWallet"]},"walletReference":{"type":"string","description":"A reference identifying the destination wallet.","maxLength":50,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s@!\\u00A3*#$)(+\\-_=.,/;:'\"]*$"}},"required":["type","walletReference"]}},"components/schemas/FundTransferAddress":{"id":"components/schemas/FundTransferAddress","kind":"json-schema","title":"FundTransferAddress","data":{"type":"object","properties":{"address1":{"type":"string","description":"Must be supplied if city is provided.","maxLength":80,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s]*$"},"address2":{"type":"string","maxLength":80,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s]*$"},"city":{"type":"string","description":"Must be supplied if address1 is provided.","maxLength":50,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s]*$"},"countryCode":{"type":"string","description":"Country code in ISO 3166-1 Alpha-2 format.","minLength":2},"postalCode":{"type":"string","maxLength":10,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s]*$"},"state":{"type":"string","description":"1-3 alphanumeric characters and spaces.","maxLength":3,"minLength":1,"pattern":"^(?!\\s*$)[a-zA-Z0-9\\s]*$"}},"required":["countryCode"]}},"components/schemas/FundTransferRecipient":{"id":"components/schemas/FundTransferRecipient","kind":"json-schema","title":"FundTransferRecipient","data":{"type":"object","description":"An object containing details about the recipient of funds. This includes name and address information, as well as recipient account details. In many use cases, the recipient is the same person as the sender (for example if your customer uses their card to load funds into their own crypto exchange or investment account). Although an optional object in the API schema, recipient is required for some regions and use cases.","properties":{"account":{"$ref":"#/components/schemas/FundTransferAccount"},"address":{"$ref":"#/components/schemas/FundTransferAddress"},"dateOfBirth":{"type":"string","description":"Recipient's date of birth","pattern":"^([0-9]{4})(-)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$"},"documentReference":{"type":"string","description":"Required for domestic processing in some Latin American countries.","maxLength":25,"minLength":1,"pattern":"^[-A-Za-z0-9_/\\\\*~+.,&()]*$"},"firstName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient's first name. You must supply this, if you provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"middleName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":22,"minLength":1,"pattern":"^(?!\\s*$).*$"},"lastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient's last name. You must supply this, if you provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"middleName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":22,"minLength":1,"pattern":"^(?!\\s*$).*$"},"middleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient's middle name. You must only supply this, if you provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":22,"minLength":1,"pattern":"^(?!\\s*$).*$"},"phoneNumber":{"type":"string","description":"Recipient's phone number","maxLength":20,"minLength":4,"pattern":"^(?!\\s*$)[0-9\\s()+\\-/.x]*$"}}}},"components/schemas/FundTransferSender":{"id":"components/schemas/FundTransferSender","kind":"json-schema","title":"FundTransferSender","data":{"type":"object","description":"An object containing details about the sender of funds, including name and address information. The sender account is always the card account declared within instruction.paymentInstrument. Although an optional object in the API schema, sender is required for some regions and use cases.","properties":{"address":{"$ref":"#/components/schemas/FundTransferAddress"},"dateOfBirth":{"type":"string","description":"Sender's date of birth","pattern":"^([0-9]{4})(-)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$"},"documentReference":{"type":"string","description":"Sender's document reference (e.g. Tax ID). Required for domestic processing in some Latin American countries.","maxLength":25,"minLength":1,"pattern":"^[-A-Za-z0-9_/\\\\*~+.,&()]*$"},"firstName":{"type":"string","description":"Sender's first name. Must be supplied if lastName or middleName are provided.","maxLength":22,"minLength":1,"pattern":"^(?!\\s*$).*$"},"lastName":{"type":"string","description":"Sender's last name. Must be supplied if firstName or middleName are provided.","maxLength":22,"minLength":1,"pattern":"^(?!\\s*$).*$"},"middleName":{"type":"string","description":"Sender's middle name. Must only be supplied if first or last name are provided","maxLength":22,"minLength":1,"pattern":"^(?!\\s*$).*$"}}}},"components/schemas/FundsTransfer":{"id":"components/schemas/FundsTransfer","kind":"json-schema","title":"FundsTransfer","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains details of the funds transfer request, which is a money movement for a reason other than the purchase of goods or services (also known as Account Funding Transaction (AFT))."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read more in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments/enable-features/account-funding-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Funding Transactions guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"purpose":{"type":"string","description":"Specifies the purpose of the funds transfer. Required for some regions and use cases.","enum":["businessToBusiness","creditCardRepayment","crypto","crowdLending","debitCard","education","emergency","familySupport","gift","giftCard","gaming","highRiskSecurities","liquidAssets","medical","payroll","prepaidCard","salary","savings","travel","other"]},"recipient":{"$ref":"#/components/schemas/FundTransferRecipient"},"sender":{"$ref":"#/components/schemas/FundTransferSender"},"type":{"type":"string","description":"Specifies the type of the funds transfer. Note: You may only submit the fundsTransfer.type values that relate to the use cases that you have been approved for by the schemes.","enum":["accountToAccount","cash","disbursement","personToPerson","purchase","topUp","walletLoad"]}},"required":["type"]}},"components/schemas/HostedProperties":{"id":"components/schemas/HostedProperties","kind":"json-schema","title":"HostedProperties","data":{"type":"object","description":"Add properties customization to allow merchants to specify the look of the payment page.","properties":{"applePayButtonStyle":{"type":"string","description":"Change the color displayed on the Apple Pay button. Accepts values: black, white-outline, white.","maxLength":20,"minLength":0},"applePayButtonType":{"type":"string","description":"Change the text displayed on the Apple Pay button. Accepts values: plain, book, buy, check-out, donate, set-up, subscribe, add-money, contribute, order, reload, rent, support, tip, top-up.","maxLength":20,"minLength":0},"disableStrictUrls":{"type":"string","description":"When set to true/false, append the additional information after/before the result URL query string. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"googlePayButtonColour":{"type":"string","description":"Change the color displayed on the Google Pay button. Accepts values: white or black.","maxLength":20,"minLength":0},"googlePayButtonLabel":{"type":"string","description":"Change the text displayed on the Google Pay button. Accepts values: long or short.","maxLength":20,"minLength":0},"maskCardDetails":{"type":"string","description":"Hide card and CVC number as they are typed. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"passBackErrorReasons":{"type":"string","description":"Append error reasons to the result URL. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"paymentButtonLabel":{"type":"string","description":"Options to change the payment button text. Accepts values: makePayment, submitPayment, buyNow, payNow, pay, saveAccount, saveCard, save, add, addCard, bookNow, continue.","maxLength":20,"minLength":0},"sendURLParameters":{"type":"string","description":"Send url parameters in the callback. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showBillingAddress":{"type":"string","description":"Displays the billing address of the customer on the payment pages. Accepts ENUM values: SHOW, HIDE, and EDIT.","maxLength":20,"minLength":0},"showCancelButton":{"type":"string","description":"Display the cancel button that lets customer cancel the payment. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showCardIcons":{"type":"string","description":"Display logos for card payments on the payment page. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showCardholderName":{"type":"string","description":"Display the card holder name on the payment page. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showChangePaymentMethodButton":{"type":"string","description":"Display the change payment method button to let customer return to the payment method selection page. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showContactDetails":{"type":"string","description":"Displays the contact details of the customer on the payment pages. Accepts ENUM values: SHOW, HIDE, and EDIT.","maxLength":20,"minLength":0},"showCountryList":{"type":"string","description":"Displays a drop-down list of countries on the payment pages. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showFooter":{"type":"string","description":"Display the worldpay copyright information footer on the payment page. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showHeader":{"type":"string","description":"Display the selected logo and associated space around the logo Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showLanguageList":{"type":"string","description":"Displays a drop-down list of languages on the payment pages. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showPaymentDetailsHeader":{"type":"string","description":"Display the payment header on the payment page. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showPoweredByWorldPay":{"type":"string","description":"The \"Powered by Worldpay\" logo (referring to \"worldpay\" on the payment pages) is displayed while content is being displayed on a payment page. Accepts boolean values: true or false.","maxLength":20,"minLength":0},"showShippingAddress":{"type":"string","description":"Displays the shipping address of the customer on the payment pages. Accepts ENUM values: SHOW, HIDE, and EDIT.","maxLength":20,"minLength":0}}}},"components/schemas/Inputs":{"id":"components/schemas/Inputs","kind":"json-schema","title":"Inputs","data":{"type":"object","description":"Defines custom styling options for input fields including placeholder text and validation messages.","properties":{"backgroundColor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for background color. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"border":{"$ref":"#/components/schemas/Border"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for text color. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"fonts":{"$ref":"#/components/schemas/Fonts"},"placeholder":{"$ref":"#/components/schemas/Placeholder"},"validation":{"$ref":"#/components/schemas/Validation"}}}},"components/schemas/Links":{"id":"components/schemas/Links","kind":"json-schema","title":"Links","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object including a link allowing you to query our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/access/products/payment-queries"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Queries API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with which you can manage your payment."},"children":[]}]}]}],"properties":{"self":{"$ref":"#/components/schemas/TransactionResponseLink"}}}},"components/schemas/Merchant":{"id":"components/schemas/Merchant","kind":"json-schema","title":"Merchant","data":{"type":"object","description":"An object that contains information about the merchant.","properties":{"entity":{"type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding.","maxLength":32,"minLength":1,"pattern":"^([A-Za-z0-9]+[A-Za-z0-9 ]*)?$"}},"required":["entity"]}},"components/schemas/Narrative":{"id":"components/schemas/Narrative","kind":"json-schema","title":"Narrative","data":{"type":"object","description":"The text that appears on your customer's statement. Used to identify the merchant.","properties":{"line1":{"type":"string","description":"line1 is used to provide basic details about the merchant.","pattern":"^[a-zA-Z0-9\\-\\.\\,\\ ]*$"}},"required":["line1"]}},"components/schemas/Page":{"id":"components/schemas/Page","kind":"json-schema","title":"Page","data":{"type":"object","description":"Defines default styling for the payment page. These settings apply globally unless overridden by more specific component styles (e.g buttons, inputs).","properties":{"backgroundColor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for background color. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"border":{"$ref":"#/components/schemas/Border"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for text color. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"fonts":{"$ref":"#/components/schemas/Fonts"}}}},"components/schemas/PaymentInstrument":{"id":"components/schemas/PaymentInstrument","kind":"json-schema","title":"PaymentInstrument","data":{"type":"object","description":"An object that contains the payment type and details.","discriminator":{"mapping":{"card/tokenized":"#/components/schemas/TokenPaymentInstrument"},"propertyName":"type"},"properties":{"type":{"type":"string","description":"The type of instrument."}},"required":["type"]}},"components/schemas/Placeholder":{"id":"components/schemas/Placeholder","kind":"json-schema","title":"Placeholder","data":{"type":"object","description":"Defines styling options for placeholder text in input fields.","properties":{"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code for the placeholder text. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"}}}},"components/schemas/ResultURLs":{"id":"components/schemas/ResultURLs","kind":"json-schema","title":"ResultURLs","data":{"type":"object","description":"An object containing the different URLs we redirect your customers to when we receive the payment result. We recommend that you provide us with your custom result URLs.","properties":{"cancelURL":{"type":"string","description":"When your customer cancels a transaction, we redirect that customer to the cancel URL."},"errorURL":{"type":"string","description":"When we receive the payment result for an erroneous payment, we redirect your customer to the error URL."},"expiryURL":{"type":"string","description":"When a customer leaves the payment transaction uncompleted within the maximum allowed time frame, we redirect your customer to the expiry URL."},"failureURL":{"type":"string","description":"When a payment fails, we redirect your customer to the failure URL."},"pendingURL":{"type":"string","description":"When we receive the payment result for a pending payment transaction, we redirect your customer to the pending URL."},"successURL":{"type":"string","description":"When we receive the payment result for a successful payment, we redirect your customer to the success URL."}}}},"components/schemas/RiskData":{"id":"components/schemas/RiskData","kind":"json-schema","title":"RiskData","data":{"type":"object","description":"Data used for fraud and risk protection.","properties":{"account":{"$ref":"#/components/schemas/RiskDataAccount"},"custom":{"$ref":"#/components/schemas/RiskDataCustom"},"shipping":{"$ref":"#/components/schemas/RiskDataShipping"},"transaction":{"$ref":"#/components/schemas/RiskDataTransaction"}}}},"components/schemas/RiskDataAccount":{"id":"components/schemas/RiskDataAccount","kind":"json-schema","title":"RiskDataAccount","data":{"type":"object","description":"Object containing all customer account related risk data.","properties":{"dateOfBirth":{"type":"string","description":"The date of birth of the customer.","pattern":"^([0-9]{4})(-)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$"},"email":{"type":"string","description":"The customer's email address.","maxLength":128,"minLength":3,"pattern":"^(.+@.+\\..+)?$"},"history":{"$ref":"#/components/schemas/RiskDataHistory"},"previousSuspiciousActivity":{"type":"boolean","description":"Indicates whether there's been suspicious activity in the past."},"shopperId":{"type":"string","description":"A unique identifier of the customer.","maxLength":128,"minLength":1},"type":{"type":"string","description":"The type of account being used by the customer.\n\nguestUser - Order placed without full merchant account registration (no password)\n\nregisteredUser- Order placed with full merchant account registration (password entered)\n\nfederatedAccount - Using a Federated ID\n\nissuerCredentials- Using issuer credentials\n\nthirdPartyAuthentication - Using third party authentication\n\nfidoAuthenticator - FIDO authentication standard\n","pattern":"guestUser|registeredUser|federatedAccount|issuerCredentials|thirdPartyAuthentication|fidoAuthenticator"}}}},"components/schemas/RiskDataCustom":{"id":"components/schemas/RiskDataCustom","kind":"json-schema","title":"RiskDataCustom","data":{"type":"object","description":"An object containing all data that can be used to configure manual fraud rules.","properties":{"number1":{"type":"string","description":"Custom numeric value you can use to configure manual fraud rules."},"number2":{"type":"string","description":"Custom numeric value you can use to configure manual fraud rules."},"number3":{"type":"string","description":"Custom numeric value you can use to configure manual fraud rules."},"number4":{"type":"string","description":"Custom numeric value you can use to configure manual fraud rules."},"number5":{"type":"string","description":"Custom numeric value you can use to configure manual fraud rules."},"number6":{"type":"string","description":"Custom numeric value you can use to configure manual fraud rules."},"number7":{"type":"string","description":"Custom numeric value you can use to configure manual fraud rules."},"number8":{"type":"string","description":"Custom numeric value you can use to configure manual fraud rules."},"number9":{"type":"string","description":"Custom numeric value you can use to configure manual fraud rules."},"string1":{"type":"string","description":"Custom string value you can use to configure manual fraud rules."},"string2":{"type":"string","description":"Custom string value you can use to configure manual fraud rules."},"string3":{"type":"string","description":"Custom string value you can use to configure manual fraud rules."},"string4":{"type":"string","description":"Custom string value you can use to configure manual fraud rules."},"string5":{"type":"string","description":"Custom string value you can use to configure manual fraud rules."},"string6":{"type":"string","description":"Custom string value you can use to configure manual fraud rules."},"string7":{"type":"string","description":"Custom string value you can use to configure manual fraud rules."},"string8":{"type":"string","description":"Custom string value you can use to configure manual fraud rules."},"string9":{"type":"string","description":"Custom string value you can use to configure manual fraud rules."}}}},"components/schemas/RiskDataGiftCardsPurchase":{"id":"components/schemas/RiskDataGiftCardsPurchase","kind":"json-schema","title":"RiskDataGiftCardsPurchase","data":{"type":"object","description":"Provided when the order is being used to purchase a gift card.","properties":{"quantity":{"type":"integer","format":"int32","description":"The number of gift cards being purchased.","maximum":99,"minimum":1},"totalValue":{"$ref":"#/components/schemas/RiskDataTotalValue"}}}},"components/schemas/RiskDataHistory":{"id":"components/schemas/RiskDataHistory","kind":"json-schema","title":"RiskDataHistory","data":{"type":"object","description":"History of the customer's account.","properties":{"createdAt":{"type":"string","description":"The ISO 8601 date of when the customer's account was created.","pattern":"^([0-9]{4})(-)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$"},"modifiedAt":{"type":"string","description":"The ISO 8601 date of when the customer's account was last modified.","pattern":"^([0-9]{4})(-)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$"},"passwordModifiedAt":{"type":"string","description":"The ISO 8601 date of when the customer's account password was last modified.","pattern":"^([0-9]{4})(-)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$"},"paymentAccountEnrolledAt":{"type":"string","description":"The ISO 8601 date of when the payment account was added to the customer's account.","pattern":"^([0-9]{4})(-)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$"}}}},"components/schemas/RiskDataShipping":{"id":"components/schemas/RiskDataShipping","kind":"json-schema","title":"RiskDataShipping","data":{"type":"object","description":"Object containing all data related to how the order will be shipped.","properties":{"address":{"$ref":"#/components/schemas/RiskDataShippingAddress"},"email":{"type":"string","description":"The email address used for an electronic delivery.","maxLength":128,"minLength":3,"pattern":"^(.+@.+\\..+)?$"},"firstName":{"type":"string","description":"The first name of the shipping address.","maxLength":22,"minLength":1},"lastName":{"type":"string","description":"The last name of the shipping address.","maxLength":22,"minLength":1},"method":{"type":"string","description":"The shipping method used.\n\nbillingAddress - Ship to customers billing address\n\nverifiedAddress- Ship to another verified address on file with merchant\n\notherAddress- Ship to address that is different than billing address\n\nstore - Ship to store (store address should be populated on request)\n\ndigital - Digital goods\n\nunshippedTickets - Travel and event tickets, not shipped\n\nother - Other\n","pattern":"billingAddress|verifiedAddress|otherAddress|store|digital|unshippedTickets|other"},"nameMatchesAccountName":{"type":"boolean","description":"Indicates whether the customer's name matches the name used for the shipping address."},"timeFrame":{"type":"string","description":"The timeframe to ship the purchased goods.","pattern":"electronic|twoDaysPlus|nextDay|sameDay"}}}},"components/schemas/RiskDataShippingAddress":{"id":"components/schemas/RiskDataShippingAddress","kind":"json-schema","title":"RiskDataShippingAddress","data":{"type":"object","properties":{"address1":{"type":"string","description":"Address line 1.","maxLength":80,"minLength":1},"address2":{"type":"string","description":"Address line 2.","maxLength":80,"minLength":0},"address3":{"type":"string","description":"Address line 3.","maxLength":80,"minLength":0},"city":{"type":"string","description":"Address city.","maxLength":50,"minLength":1},"countryCode":{"type":"string","description":"The supported ISO 3166-1 alpha-2 country code.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"phoneNumber":{"type":"string","description":"Address phone number.","maxLength":20,"minLength":4,"pattern":"^[0-9]*$"},"postalCode":{"type":"string","description":"Address postal code or zip number.","maxLength":15,"minLength":1},"state":{"type":"string","description":"Address state or region.","maxLength":30,"minLength":1}},"required":["address1","city","countryCode","postalCode"]}},"components/schemas/RiskDataTotalValue":{"id":"components/schemas/RiskDataTotalValue","kind":"json-schema","title":"RiskDataTotalValue","data":{"type":"object","description":"The payment amount.","properties":{"amount":{"type":"integer","format":"int32","description":"The amount being placed on the gift card.","minimum":0},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The three character currency code. See list of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.worldpay.com/products/reference/useful-tables/#currency-codes"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$"}},"required":["amount","currency"]}},"components/schemas/RiskDataTransaction":{"id":"components/schemas/RiskDataTransaction","kind":"json-schema","title":"RiskDataTransaction","data":{"type":"object","description":"Object containing all customer transaction related risk data.","properties":{"firstName":{"type":"string","description":"Customer's first name.","maxLength":22,"minLength":1},"giftCardsPurchase":{"$ref":"#/components/schemas/RiskDataGiftCardsPurchase"},"history":{"$ref":"#/components/schemas/RiskDataTransactionHistory"},"lastName":{"type":"string","description":"Customer's last name.","maxLength":22,"minLength":1},"phoneNumber":{"type":"string","description":"Customer's phone number.","maxLength":20,"minLength":4,"pattern":"^[0-9]*$"},"preOrderDate":{"type":"string","description":"Expected ISO 8601 date that a pre-ordered purchase will be available.","pattern":"^([0-9]{4})(-)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$"},"reorder":{"type":"boolean","description":"Indicates whether this transaction is a reorder of a previous order."}}}},"components/schemas/RiskDataTransactionHistory":{"id":"components/schemas/RiskDataTransactionHistory","kind":"json-schema","title":"RiskDataTransactionHistory","data":{"type":"object","description":"Object containing details of the last transaction.","properties":{"addCardsLastDay":{"type":"integer","format":"int32","description":"Number of attempts to add a card in the last 24hrs.","maximum":999,"minimum":0},"attemptsLastDay":{"type":"integer","format":"int32","description":"Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.","maximum":999,"minimum":0},"attemptsLastYear":{"type":"integer","format":"int32","description":"Number of transactions (successful or abandoned) for this cardholder account within the last year.","maximum":999,"minimum":0},"completedLastSixMonths":{"type":"integer","format":"int32","description":"Number of purchases with this customer account during the previous six months.","maximum":9999,"minimum":0},"shippingAddressFirstUsedAt":{"type":"string","description":"The ISO 8601 date of when the shipping address, used for this transaction, was first used.","pattern":"^([0-9]{4})(-)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$"}}}},"components/schemas/Settlement":{"id":"components/schemas/Settlement","kind":"json-schema","title":"Settlement","data":{"type":"object","description":"A value when specified allows you to turn auto settlement off. The default behavior is \"true\" and there is nothing to specify.","properties":{"auto":{"type":"boolean"},"cancelOn":{"$ref":"#/components/schemas/CancelOn"}}}},"components/schemas/SuccessfulCreateTransactionResponse":{"id":"components/schemas/SuccessfulCreateTransactionResponse","kind":"json-schema","title":"SuccessfulCreateTransactionResponse","data":{"type":"object","description":"Response for when a HPP URL is created.","properties":{"_links":{"$ref":"#/components/schemas/Links"},"url":{"type":"string","description":"The URL where your customer can be redirected to, to complete their payment."}}}},"components/schemas/ThreeDS":{"id":"components/schemas/ThreeDS","kind":"json-schema","title":"ThreeDS","data":{"type":"object","description":"An object containing 3DS authentication preferences, which you can use to turn 3DS off.","properties":{"type":{"type":"string","description":"The 3DS type.","enum":["disabled"]}}}},"components/schemas/TokenPaymentInstrument":{"id":"components/schemas/TokenPaymentInstrument","kind":"json-schema","title":"TokenPaymentInstrument","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"type":"object","properties":{"href":{"type":"string","description":"The URL to an Access token. We return this after token creation via the API or webhook callback."}}}],"required":["href","type"]}},"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","data":{"type":"object","description":"The request used to setup a new HPP URL.","properties":{"billingAddress":{"$ref":"#/components/schemas/BillingAddress"},"createToken":{"$ref":"#/components/schemas/CreateToken"},"customerAgreement":{"$ref":"#/components/schemas/CustomerAgreement"},"customisation_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique value generated by us that represents "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/hosted-payment-pages/configuration#select-channel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the channel in the Payment Page Designer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If not sent, the \"default\" channel settings apply. You can overwrite individual customization styles and properties by using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hostedCustomization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hostedProperties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}],"maxLength":21,"minLength":21,"pattern":"^[A-Za-z0-9\\_\\-]*$"},"description":{"type":"string","description":"An optional text, when supplied is displayed to your customer on payment pages.","maxLength":128,"minLength":0},"expiry":{"type":"integer","format":"int64","default":3600,"description":"Allows you to configure the duration, in seconds, your customer can access the payment link.","maximum":2592000,"minimum":300},"fraud":{"$ref":"#/components/schemas/Fraud"},"fundsTransfer":{"$ref":"#/components/schemas/FundsTransfer"},"hostedCustomization":{"$ref":"#/components/schemas/Customisation"},"hostedProperties":{"$ref":"#/components/schemas/HostedProperties"},"locale":{"type":"string","description":"A BCP 47 locale tag, from the specified list. If set to null or absent from the request, will default to English (en).","enum":["ar","bg","bs","ca","cs","cy","da","de","en","el","es","es-CO","et","fi","fr","ga","he","hi","hr","hu","it","ja","ko","lt","lv","nl","no","pl","pt","pt-BR","ro","ru","si","sk","sl","sv","th","tr","ua","zh","zh-TW"]},"merchant":{"$ref":"#/components/schemas/Merchant"},"narrative":{"$ref":"#/components/schemas/Narrative"},"paymentInstrument":{"oneOf":[{"$ref":"#/components/schemas/TokenPaymentInstrument"}]},"resultURLs":{"$ref":"#/components/schemas/ResultURLs"},"riskData":{"$ref":"#/components/schemas/RiskData"},"settlement":{"$ref":"#/components/schemas/Settlement"},"threeDS":{"$ref":"#/components/schemas/ThreeDS"},"transactionReference":{"type":"string","description":"A unique reference generated by you that is used to identify a payment throughout its lifecycle.","maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-\\_\\/\\!\\@\\#\\$\\%\\(\\)\\*\\=\\.\\:\\;\\?\\[\\]\\{\\}\\~\\+]*$"},"value":{"$ref":"#/components/schemas/Value"}},"required":["merchant","narrative","transactionReference","value"]}},"components/schemas/TransactionResponseLink":{"id":"components/schemas/TransactionResponseLink","kind":"json-schema","title":"TransactionResponseLink","data":{"type":"object","properties":{"href":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to query our database by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which gives you the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can then use this to make follow on actions such as cancelling and refunding a payment."},"children":[]}]}]}]}}}},"components/schemas/Validation":{"id":"components/schemas/Validation","kind":"json-schema","title":"Validation","data":{"type":"object","description":"Styling properties for validation messages in input fields, including success and error indicators.","properties":{"error":{"$ref":"#/components/schemas/ValidationStatus"},"ok":{"$ref":"#/components/schemas/ValidationStatus"}}}},"components/schemas/ValidationStatus":{"id":"components/schemas/ValidationStatus","kind":"json-schema","title":"ValidationStatus","data":{"type":"object","description":"Styling properties for validation status messages, defining colors for success or error states.","properties":{"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code defining the style of the validation messages. You can use three digit or six digit codes (e.g. #FF0 or #DD99CC)."},"children":[]}]}]}],"maxLength":20,"minLength":0,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"}}}},"components/schemas/Value":{"id":"components/schemas/Value","kind":"json-schema","title":"Value","data":{"type":"object","description":"The payment amount.","properties":{"amount":{"type":"integer","format":"int64","description":"The payment amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2.50.","minimum":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The three character currency code. See list of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.worldpay.com/products/reference/useful-tables/#currency-codes"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["amount"]}},"schema_397":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9a-zA-Z_-]{1,64}$"},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"type":"string"},"id":"schema_398"}},"exampleStore":{"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border bank account max fields)":{"value":{"transactionReference":"fundsTransferTx005","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Cross border bank account"},"value":{"currency":"USD","amount":2500},"fundsTransfer":{"type":"personToPerson","purpose":"familySupport","sender":{"firstName":"Jane","middleName":"Alice","lastName":"Doe","dateOfBirth":"1989-04-09","documentReference":"TAX-998877","address":{"address1":"120 Main Street","address2":"Apartment 5","city":"New York","postalCode":"10001","state":"NY","countryCode":"US"}},"recipient":{"firstName":"John","middleName":"David","lastName":"Doe","dateOfBirth":"1987-11-21","phoneNumber":"+1 416 555 0111","documentReference":"ID-445566","account":{"type":"bankAccount","identifierType":"swift","iban":"DE89370400440532013000","accountNumber":"123456789012","swiftBic":"BOFAUS3NXXX","routingNumber":"021000021"},"address":{"address1":"25 Queen Street","address2":"Suite 8","city":"Toronto","postalCode":"M5H 2N2","state":"ON","countryCode":"CA"}}}},"key":"Funds transfer (cross-border bank account max fields)","summary":"Funds transfer (cross-border bank account max fields)","description":"Create transaction request including optional cross-border fundsTransfer with recipient bankAccount details","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border bank account max fields)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border)":{"value":{"transactionReference":"fundsTransferTx002","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Cross-border wallet"},"value":{"currency":"USD","amount":2500},"fundsTransfer":{"type":"walletLoad","purpose":"gaming","sender":{"firstName":"Jane","lastName":"Doe","dateOfBirth":"1989-04-09","address":{"address1":"120 Main Street","city":"New York","postalCode":"10001","state":"NY","countryCode":"US"}},"recipient":{"firstName":"John","lastName":"Doe","account":{"type":"storedValueWallet","walletReference":"stored-wallet-456"},"address":{"address1":"25 Queen Street","city":"Auckland","postalCode":"1010","countryCode":"NZ"}}}},"key":"Funds transfer (cross-border)","summary":"Funds transfer (cross-border)","description":"Create transaction request including optional cross-border fundsTransfer","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (cross-border)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (domestic)":{"value":{"transactionReference":"fundsTransferTx003","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Domestic"},"value":{"currency":"GBP","amount":5000},"fundsTransfer":{"type":"walletLoad","purpose":"gaming","recipient":{"firstName":"Richard","lastName":"Smith","account":{"type":"wallet","walletReference":"wallet-domestic-789"}}}},"key":"Funds transfer (domestic)","summary":"Funds transfer (domestic)","description":"Create transaction request including optional domestic fundsTransfer","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (domestic)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum email)":{"value":{"transactionReference":"fundsTransferTx006","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Funds transfer"},"value":{"currency":"GBP","amount":123},"fundsTransfer":{"type":"purchase","purpose":"other","recipient":{"account":{"type":"email","emailAddress":"recipient@example.com"}}}},"key":"Funds transfer (minimum email)","summary":"Funds transfer (minimum email)","description":"Create transaction request including optional fundsTransfer with recipient email account details","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum email)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum)":{"value":{"transactionReference":"fundsTransferTx001","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Funds transfer"},"value":{"currency":"GBP","amount":123},"fundsTransfer":{"type":"purchase","purpose":"crypto","recipient":{"account":{"type":"wallet","walletReference":"wallet-123"}}}},"key":"Funds transfer (minimum)","summary":"Funds transfer (minimum)","description":"Create transaction request including optional fundsTransfer (minimum)","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (minimum)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (stored value)":{"value":{"transactionReference":"fundsTransferTx004","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Stored value"},"value":{"currency":"EUR","amount":7500},"fundsTransfer":{"type":"cash","purpose":"gaming","recipient":{"firstName":"Marie","lastName":"Dupont","account":{"type":"storedValueWallet","walletReference":"stored-wallet-567"},"address":{"address1":"5 Rue de la Paix","city":"Paris","postalCode":"75000","countryCode":"FR"}}}},"key":"Funds transfer (stored value)","summary":"Funds transfer (stored value)","description":"Create transaction request including optional storedValueWallet fundsTransfer","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Funds transfer (stored value)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (all fields)":{"value":{"transactionReference":"MyTransaction123","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"line1"},"value":{"currency":"GBP","amount":123},"description":"Mind Palace Ltd","billingAddressName":"Sherlock Holmes","billingAddress":{"firstName":"John","lastName":"Watson","address1":"221B Baker Street","address2":"Marylebone","address3":"Westminster","postalCode":"NW1 6XE","city":"London","state":"Greater London","countryCode":"GB"},"resultURLs":{"successURL":"https://mindpalace-website/result/success","pendingURL":"https://mindpalace-website/result/pending","failureURL":"https://mindpalace-website/result/failure","errorURL":"https://mindpalace-website/result/error","cancelURL":"https://mindpalace-website/result/cancel","expiryURL":"https://mindpalace-website/result/expiry"},"riskData":{"shipping":{"firstName":"James","lastName":"Moriarty","address":{"city":"Durham","address1":"The Palatine Centre","address2":"Durham University","address3":"Stockton Road","state":"County Durham","countryCode":"GB","postalCode":"DH1 3LE","phoneNumber":"01189998819999197253"},"method":"verifiedAddress","nameMatchesAccountName":false,"email":"james.moriarty@example.com","timeFrame":"nextDay"},"custom":{"string1":"foo","number1":"1","string2":"foo","number2":"1","string3":"foo","number3":"1","string4":"foo","number4":"1","string5":"foo","number5":"1","string6":"foo","number6":"1","string7":"foo","number7":"1","string8":"foo","number8":"1","string9":"foo","number9":"1"},"account":{"shopperId":"1234","dateOfBirth":"1835-04-01","history":{"createdAt":"1876-06-01","modifiedAt":"1876-08-13","paymentAccountEnrolledAt":"1876-06-01","passwordModifiedAt":"1876-06-01"},"type":"fidoAuthenticator","previousSuspiciousActivity":false,"email":"sherlock.holmes@example.com"},"transaction":{"firstName":"James","lastName":"Moriarty","phoneNumber":"01189998819999197253","preOrderDate":"1876-08-13","reorder":false,"history":{"attemptsLastYear":3,"completedLastSixMonths":4,"attemptsLastDay":2,"shippingAddressFirstUsedAt":"1876-06-01","addCardsLastDay":1},"giftCardsPurchase":{"totalValue":{"amount":10000,"currency":"GBP"},"quantity":1}}},"fundsTransfer":{"type":"personToPerson","purpose":"familySupport","sender":{"firstName":"Jane","middleName":"Alice","lastName":"Doe","dateOfBirth":"1989-04-09","documentReference":"TAX-998877","address":{"address1":"120 Main Street","address2":"Apartment 5","city":"New York","postalCode":"10001","state":"NY","countryCode":"US"}},"recipient":{"firstName":"John","middleName":"David","lastName":"Doe","dateOfBirth":"1987-11-21","phoneNumber":"+1 416 555 0111","documentReference":"ID-445566","account":{"type":"bankAccount","identifierType":"swift","iban":"DE89370400440532013000","accountNumber":"123456789012","swiftBic":"BOFAUS3NXXX","routingNumber":"021000021"},"address":{"address1":"25 Queen Street","address2":"Suite 8","city":"Toronto","postalCode":"M5H 2N2","state":"ON","countryCode":"CA"}}},"hostedCustomization":{"backgroundColor":"#FFFFFF","color":"#000000","page":{"backgroundColor":"#333333","color":"#FFFFFF","border":{"color":"#CCCCCC","width":"1px","style":"solid","radius":"4px"},"fonts":{"family":["Comic Sans MS"]}},"buttons":{"backgroundColor":"#FF0","color":"#333333","border":{"style":"solid","color":"#0FF","width":"3px","radius":"0px"},"fonts":{"family":["Comic Sans MS"]},"hover":{"backgroundColor":"#DDF","color":"#111111","border":{"color":"#BBBBBB","width":"2px","style":"dotted","radius":"0px"},"fonts":{"family":["Comic Sans MS"]}},"focus":{"backgroundColor":"#DFD","color":"#222222","border":{"color":"#CCCCCC","width":"2px","style":"solid","radius":"0px"},"fonts":{"family":["Comic Sans MS"]}}},"inputs":{"backgroundColor":"#FFFFFF","color":"#000000","border":{"style":"solid","width":"2px","radius":"2px","color":"#FFF"},"fonts":{"family":["Comic Sans MS"]},"placeholder":{"color":"#001"},"validation":{"ok":{"color":"#00F"},"error":{"color":"#F00"}},"hover":{"backgroundColor":"#FF0000","color":"#7F0000","border":{"color":"#0FF","width":"1px","style":"solid","radius":"2px"},"fonts":{"family":["Comic Sans MS"]},"placeholder":{"color":"#AAAAAA"},"validation":{"ok":{"color":"#00CC00"},"error":{"color":"#CC0000"}}},"focus":{"backgroundColor":"#0240FF","color":"#001F7F","border":{"color":"#0FF","width":"1px","style":"solid","radius":"2px"},"fonts":{"family":["Comic Sans MS"]},"placeholder":{"color":"#BBBBBB"},"validation":{"ok":{"color":"#009900"},"error":{"color":"#990000"}}}},"fonts":{"family":["Comic Sans MS"]}},"hostedProperties":{"showBillingAddress":"EDIT","showShippingAddress":"HIDE","showCountryList":"false","showLanguageList":"false","showContactDetails":"HIDE","sendURLParameters":"true","showPoweredByWorldPay":"true","showCancelButton":"true","showChangePaymentMethodButton":"false","disableStrictUrls":"true","showHeader":"true","showFooter":"true","showCardIcons":"false","paymentButtonLabel":"makePayment","showCardholderName":"true","showPaymentDetailsHeader":"true","passBackErrorReasons":"true","maskCardDetails":"false","googlePayButtonColour":"black","googlePayButtonLabel":"long","applePayButtonType":"plain","applePayButtonStyle":"black"},"settlement":{"auto":true,"cancelOn":{"cvcNotMatched":"disabled"}},"expiry":"600"},"key":"Guest Card Payment (all fields)","summary":"Guest Card Payment (all fields)","description":"Create transaction request, all key:values","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (all fields)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (mandatory fields)":{"value":{"transactionReference":"MyTransaction123","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Mind Palace Ltd"},"value":{"currency":"GBP","amount":123}},"key":"Guest Card Payment (mandatory fields)","summary":"Guest Card Payment (mandatory fields)","description":"Create transaction request, required key:values","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest Card Payment (mandatory fields)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest card payment (using customisation_id)":{"value":{"transactionReference":"MyTransaction123","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Mind Palace Ltd"},"value":{"currency":"GBP","amount":123},"customisation_id":"Customisationidvalue1"},"key":"Guest card payment (using customisation_id)","summary":"Guest card payment (using customisation_id)","description":"Create transaction request, all key:values","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Guest card payment (using customisation_id)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Request 3DS and FraudSight off":{"value":{"transactionReference":"MyTransaction123","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":""},"value":{"currency":"GBP","amount":123},"description":"Mind Palace Ltd","billingAddressName":"Sherlock Holmes","billingAddress":{"firstName":"John","lastName":"Watson","address1":"221B Baker Street","address2":"Marylebone","address3":"Westminster","postalCode":"NW1 6XE","city":"London","state":"Greater London","countryCode":"GB"},"resultURLs":{"successURL":"https://mindpalace-website/result/success","pendingURL":"https://mindpalace-website/result/pending","failureURL":"https://mindpalace-website/result/failure","errorURL":"https://mindpalace-website/result/error","cancelURL":"https://mindpalace-website/result/cancel","expiryURL":"https://mindpalace-website/result/expiry"},"riskData":{"shipping":{"firstName":"James","lastName":"Moriarty","address":{"city":"Durham","address1":"The Palatine Centre","address2":"Durham University","address3":"Stockton Road","state":"County Durham","countryCode":"GB","postalCode":"DH1 3LE","phoneNumber":"01189998819999197253"},"method":"verifiedAddress","nameMatchesAccountName":false,"email":"james.moriarty@example.com","timeFrame":"nextDay"},"custom":{"string1":"foo","number1":"1","string2":"foo","number2":"1","string3":"foo","number3":"1","string4":"foo","number4":"1","string5":"foo","number5":"1","string6":"foo","number6":"1","string7":"foo","number7":"1","string8":"foo","number8":"1","string9":"foo","number9":"1"},"account":{"shopperId":"1234","dateOfBirth":"1835-04-01","history":{"createdAt":"1876-06-01","modifiedAt":"1876-08-13","paymentAccountEnrolledAt":"1876-06-01","passwordModifiedAt":"1876-06-01"},"type":"fidoAuthenticator","previousSuspiciousActivity":false,"email":"sherlock.holmes@example.com"},"transaction":{"firstName":"James","lastName":"Moriarty","phoneNumber":"01189998819999197253","preOrderDate":"1876-08-13","reorder":false,"history":{"attemptsLastYear":3,"completedLastSixMonths":4,"attemptsLastDay":2,"shippingAddressFirstUsedAt":"1876-06-01","addCardsLastDay":1},"giftCardsPurchase":{"totalValue":{"amount":10000,"currency":"GBP"},"quantity":1}}},"fraud":{"type":"disabled"},"threeDS":{"type":"disabled"},"expiry":"600"},"key":"Request 3DS and FraudSight off","summary":"Request 3DS and FraudSight off","description":"Request 3DS and FraudSight off","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Request 3DS and FraudSight off"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (all fields)":{"value":{"transactionReference":"MyTransaction123","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Mind Palace Ltd"},"value":{"currency":"GBP","amount":123},"description":"Optional text displayed on HPP to your customer","billingAddress":{"address1":"221B Baker Street","address2":"Marylebone","address3":"Westminster","postalCode":"NW1 6XE","city":"London","state":"Greater London","countryCode":"GB"},"resultURLs":{"successURL":"https://mindpalace-website/result/success","pendingURL":"https://mindpalace-website/result/pending","failureURL":"https://mindpalace-website/result/failure","errorURL":"https://mindpalace-website/result/error","cancelURL":"https://mindpalace-website/result/cancel","expiryURL":"https://mindpalace-website/result/expiry"},"riskData":{"shipping":{"firstName":"James","lastName":"Moriarty","address":{"city":"Durham","address1":"The Palatine Centre","address2":"Durham University","address3":"Stockton Road","state":"County Durham","countryCode":"GB","postalCode":"DH1 3LE","phoneNumber":"01189998819999197253"},"method":"verifiedAddress","nameMatchesAccountName":false,"email":"james.moriarty@example.com","timeFrame":"nextDay"},"custom":{"string1":"foo","number1":"1","string2":"foo","number2":"1","string3":"foo","number3":"1","string4":"foo","number4":"1","string5":"foo","number5":"1","string6":"foo","number6":"1","string7":"foo","number7":"1","string8":"foo","number8":"1","string9":"foo","number9":"1"},"account":{"dateOfBirth":"1835-04-01","history":{"createdAt":"1876-06-01","modifiedAt":"1876-08-13","paymentAccountEnrolledAt":"1876-06-01","passwordModifiedAt":"1876-06-01"},"type":"worldpay","previousSuspiciousActivity":false,"email":"sherlock.holmes@example.com"},"transaction":{"firstName":"James","lastName":"Moriarty","phoneNumber":"01189998819999197253","preOrderDate":"1876-08-13","reorder":false,"history":{"attemptsLastYear":3,"completedLastSixMonths":4,"attemptsLastDay":2,"shippingAddressFirstUsedAt":"1876-06-01","addCardsLastDay":1},"giftCardsPurchase":{"totalValue":{"amount":123,"currency":"GBP"},"quantity":1}}},"createToken":{"type":"worldpay","namespace":"SHOPPER_ID_1234567890","description":"Test Token Description","optIn":"ASK"},"customerAgreement":{"type":"cardOnFile","storedCardUsage":"first"},"expiry":"600"},"key":"Store a Card - card on file (all fields)","summary":"Store a Card - card on file (all fields)","description":"Save a card for future customer initiated transactions (full)","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (all fields)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (mandatory fields)":{"value":{"transactionReference":"MyTransaction123","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Mind Palace Ltd"},"value":{"currency":"GBP","amount":123},"createToken":{"type":"worldpay","namespace":"SHOPPER_ID_1234567890","description":"Test Token Description","optIn":"ASK"},"customerAgreement":{"type":"cardOnFile","storedCardUsage":"first"}},"key":"Store a Card - card on file (mandatory fields)","summary":"Store a Card - card on file (mandatory fields)","description":"Save a card for future customer initiated transactions (minimum)","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - card on file (mandatory fields)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (all fields)":{"value":{"transactionReference":"MyTransaction123","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Mind Palace Ltd"},"value":{"currency":"GBP","amount":123},"description":"Optional text displayed on HPP to your customer","billingAddress":{"address1":"221B Baker Street","address2":"Marylebone","address3":"Westminster","postalCode":"NW1 6XE","city":"London","state":"Greater London","countryCode":"GB"},"resultURLs":{"successURL":"https://mindpalace-website/result/success","pendingURL":"https://mindpalace-website/result/pending","failureURL":"https://mindpalace-website/result/failure","errorURL":"https://mindpalace-website/result/error","cancelURL":"https://mindpalace-website/result/cancel","expiryURL":"https://mindpalace-website/result/expiry"},"riskData":{"shipping":{"firstName":"James","lastName":"Moriarty","address":{"city":"Durham","address1":"The Palatine Centre","address2":"Durham University","address3":"Stockton Road","state":"County Durham","countryCode":"GB","postalCode":"DH1 3LE","phoneNumber":"01189998819999197253"},"method":"verifiedAddress","nameMatchesAccountName":false,"email":"james.moriarty@example.com","timeFrame":"nextDay"},"custom":{"string1":"foo","number1":"1","string2":"foo","number2":"1","string3":"foo","number3":"1","string4":"foo","number4":"1","string5":"foo","number5":"1","string6":"foo","number6":"1","string7":"foo","number7":"1","string8":"foo","number8":"1","string9":"foo","number9":"1"},"account":{"dateOfBirth":"1835-04-01","history":{"createdAt":"1876-06-01","modifiedAt":"1876-08-13","paymentAccountEnrolledAt":"1876-06-01","passwordModifiedAt":"1876-06-01"},"type":"worldpay","previousSuspiciousActivity":false,"email":"sherlock.holmes@example.com"},"transaction":{"firstName":"James","lastName":"Moriarty","phoneNumber":"01189998819999197253","preOrderDate":"1876-08-13","reorder":false,"history":{"attemptsLastYear":3,"completedLastSixMonths":4,"attemptsLastDay":2,"shippingAddressFirstUsedAt":"1876-06-01","addCardsLastDay":1},"giftCardsPurchase":{"totalValue":{"amount":123,"currency":"GBP"},"quantity":1}}},"createToken":{"type":"worldpay","namespace":"SHOPPER_ID_1234567890","description":"Test Token Description","optIn":"ASK"},"customerAgreement":{"type":"subscription","storedCardUsage":"first"},"expiry":"600"},"key":"Store a Card - subscription (all fields)","summary":"Store a Card - subscription (all fields)","description":"Store a Card - subscription (all fields)","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (all fields)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (mandatory fields)":{"value":{"transactionReference":"MyTransaction123","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Mind Palace Ltd"},"value":{"currency":"GBP","amount":123},"createToken":{"type":"worldpay","namespace":"SHOPPER_ID_1234567890","description":"Test Token Description","optIn":"ASK"},"customerAgreement":{"type":"subscription","storedCardUsage":"first"}},"key":"Store a Card - subscription (mandatory fields)","summary":"Store a Card - subscription (mandatory fields)","description":"Store a Card - subscription (mandatory fields)","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Store a Card - subscription (mandatory fields)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (all fields)":{"value":{"transactionReference":"MyTransaction123","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Mind Palace Ltd"},"value":{"currency":"GBP","amount":123},"description":"Optional text displayed on HPP to your customer","billingAddress":{"firstName":"John","lastName":"Watson","address1":"221B Baker Street","address2":"Marylebone","address3":"Westminster","postalCode":"NW1 6XE","city":"London","state":"Greater London","countryCode":"GB"},"resultURLs":{"successURL":"https://mindpalace-website/result/success","pendingURL":"https://mindpalace-website/result/pending","failureURL":"https://mindpalace-website/result/failure","errorURL":"https://mindpalace-website/result/error","cancelURL":"https://mindpalace-website/result/cancel","expiryURL":"https://mindpalace-website/result/expiry"},"riskData":{"shipping":{"firstName":"James","lastName":"Moriarty","address":{"city":"Durham","address1":"The Palatine Centre","address2":"Durham University","address3":"Stockton Road","state":"County Durham","countryCode":"GB","postalCode":"DH1 3LE","phoneNumber":"01189998819999197253"},"method":"verifiedAddress","nameMatchesAccountName":false,"email":"james.moriarty@example.com","timeFrame":"nextDay"},"custom":{"string1":"foo","number1":"1","string2":"foo","number2":"1","string3":"foo","number3":"1","string4":"foo","number4":"1","string5":"foo","number5":"1","string6":"foo","number6":"1","string7":"foo","number7":"1","string8":"foo","number8":"1","string9":"foo","number9":"1"},"account":{"dateOfBirth":"1835-04-01","history":{"createdAt":"1876-06-01","modifiedAt":"1876-08-13","paymentAccountEnrolledAt":"1876-06-01","passwordModifiedAt":"1876-06-01"},"type":"guestUser","previousSuspiciousActivity":false,"email":"sherlock.holmes@example.com"},"transaction":{"firstName":"James","lastName":"Moriarty","phoneNumber":"01189998819999197253","preOrderDate":"1876-08-13","reorder":false,"history":{"attemptsLastYear":3,"completedLastSixMonths":4,"attemptsLastDay":2,"shippingAddressFirstUsedAt":"1876-06-01","addCardsLastDay":1},"giftCardsPurchase":{"totalValue":{"amount":10000,"currency":"GBP"},"quantity":1}}},"paymentInstrument":{"type":"card/tokenized","href":"https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"},"customerAgreement":{"type":"cardOnFile","storedCardUsage":"subsequent"},"expiry":"600"},"key":"Take Payment from a Stored Card - card on file (all fields)","summary":"Take Payment from a Stored Card - card on file (all fields)","description":"Take Payment from a Stored Card - card on file (all fields)","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (all fields)"},"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (mandatory fields)":{"value":{"transactionReference":"MyTransaction123","merchant":{"entity":"POxxxxxxxxx"},"narrative":{"line1":"Mind Palace Ltd"},"value":{"currency":"GBP","amount":123},"paymentInstrument":{"type":"card/tokenized","href":"https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"},"customerAgreement":{"type":"cardOnFile","storedCardUsage":"subsequent"}},"key":"Take Payment from a Stored Card - card on file (mandatory fields)","summary":"Take Payment from a Stored Card - card on file (mandatory fields)","description":"Take Payment from a Stored Card - card on file (mandatory fields)","id":"paths/~1payment_pages/post/requestBody/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Take Payment from a Stored Card - card on file (mandatory fields)"},"paths/~1payment_pages/post/responses/200/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Successful response":{"value":{"url":"https://payments.worldpay.com/app/hpp/integration/transaction/xxxxxxxxxxxxxxxxxxxx&cs=yyyyyy","_links":{"self":{"href":"https://access.worldpay.com/paymentQueries/payments?transactionReference=174420000000000"}}},"key":"Successful response","summary":"Successful response","description":"Successful response","id":"paths/~1payment_pages/post/responses/200/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Successful response"},"paths/~1payment_pages/post/responses/400/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Invalid request response":{"value":{"errorName":"invalidRequest","message":"Invalid request."},"key":"Invalid request response","summary":"Invalid request response","description":"Invalid request response","id":"paths/~1payment_pages/post/responses/400/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Invalid request response"},"paths/~1payment_pages/post/responses/401/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Unauthorized response":{"value":{"errorName":"unauthorized","message":"Invalid authentication"},"key":"Unauthorized response","summary":"Unauthorized response","description":"Unauthorized response","id":"paths/~1payment_pages/post/responses/401/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Unauthorized response"},"paths/~1payment_pages/post/responses/500/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Internal error response":{"value":{"errorName":"internalErrorOccurred","message":"An internal problem occurred with your request, please try again."},"key":"Internal error response","summary":"Internal error response","description":"Internal error response","id":"paths/~1payment_pages/post/responses/500/content/application~1vnd.worldpay.payment_pages-v1.hal+json/examples/Internal error response"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"BasicAuth"}},"servers":[{"url":"https://try.access.worldpay.com","description":"Test (Try)"},{"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/hosted-payment-pages/@v1/openapi.json?download"},{"url":"/access/_bundle/products/hosted-payment-pages/@v1/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code integration to take payments securely.\n\n__Authentication header__\n  ```\n    Authorization: {your_credentials}\n  ```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password given to you by your Worldpay Implementation Manager.\n<br /> <br />\n\nYou **must** use the `Authorization` header for any request you send to our Hosted Payment Pages APIs.\n\n__Accept header__\n  ```\n    Accept: application/vnd.worldpay.payment_pages-v1.hal+json\n  ```\nWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Hosted Payment Pages APIs.\n<br /><br />\n\n__DNS whitelisting__\n\nWhitelist the following URLs:\n* `https://try.access.worldpay.com/`\n* `https://access.worldpay.com/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting.","business":["SMB (Worldpay eCommerce)","Enterprise"],"catalog-list":true,"category":["3DS","Card Payments","Risk Assessments","Tokens","Wallets","Query Payments"],"generated":false}},"baseSlug":"/products/hosted-payment-pages/openapi","routesMapping":{}}