{"templateId":"markdown","versions":[{"version":"v1","label":"v1 (latest)","link":"/products/hosted-payment-pages/setup-a-payment","default":true,"active":true,"folderId":"089b7d23"}],"sharedDataIds":{"sidebar":"sidebar-products/hosted-payment-pages/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/hosted-payment-pages/openapi","oas-products/hosted-payment-pages/@v1/openapi.yaml":"oas-products/hosted-payment-pages/@v1/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition","openapi-code-sample","tabs","tab","code-snippet"]},"custom_product":"Hosted Payment Pages","type":"markdown"},"seo":{"title":"Setup a payment","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 14 June 2025 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-payment-pages/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"setup-a-payment","__idx":0},"children":["Setup a payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Our Hosted Payment Pages API generates a URL in the response. Redirect your customer to this URL to take a payment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-overview","__idx":1},"children":["Integration overview"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"graph LR\n Get-your-credentials --> Set-your-headers --> Post-your-request --> Redirect-your-customer --> Payment-is-autosettled\n","diagramHtml":"","diagramHtmlDark":""},"children":["graph LR\n Get-your-credentials --> Set-your-headers --> Post-your-request --> Redirect-your-customer --> Payment-is-autosettled\n"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Prerequisite"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Worldpay eCommerce"]}," - Pull your API credentials from your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.worldpay.com/"},"children":["dashboard"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enterprise"]}," - Contact your Worldpay Implementation Manager for your API credentials."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"set-your-headers","__idx":2},"children":["Set your headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Setting your headers is an important part of an API request. The headers represent the meta-data associated with your"," ","API request.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","You can also use our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-payment-pages/openapi"},"children":["API reference"]}," for details.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: {your_credentials}\nContent-Type: application/vnd.worldpay.payment_pages-v1.hal+json\nAccept: application/vnd.worldpay.payment_pages-v1.hal+json\n"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The mandatory ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header is used for authentication and identification of our merchants within Access Worldpay. Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{your_credentials}"]}," with your base64-encoded Basic Auth username and password you have received from us."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," header is required if the request you're sending includes a request body, and if the HTTP method is a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," or a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use the mandatory ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}," header to identify which version of our Hosted Payment Pages API you are using."]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you're using both the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}," headers, they ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["must"]}," match."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"take-a-guest-card-payment","__idx":3},"children":["Take a guest card payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," your request to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_pages:setup"]}," action link to setup a payment."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/payment_pages"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-with-mandatory-fields","__idx":4},"children":["Example with mandatory fields:"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/hosted-payment-pages/@v1/openapi.yaml","operationId":"create","exampleKey":"Guest Card Payment (mandatory fields)","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"mandatory-parameters","__idx":5},"children":["Mandatory parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data type"},"children":["Data type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field length"},"children":["Field length"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A unique reference generated by you that is used to identify a payment throughout its lifecycle. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/formatting"},"children":["transaction reference format"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be between 1 to 64 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that contains information about the merchant."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant.entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You can find your entity in your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.worldpay.com/"},"children":["Dashboard"]}," under \"Developer Tools\". Using your own entity reference causes the transaction to fail."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be between 1 and 32 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["narrative"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that helps your customers better identify you on their statement."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["narrative.line1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that helps your customers better identify you on their statement."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be between 1 and 24 characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that contains information about the payment transaction."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value.currency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The 3 character ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":["ISO currency code"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3 character ISO currency code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value.amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payment amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2.50. You can find the relevant exponent in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/supported-countries-currencies#iso-currency-codes"},"children":["currency table"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["View the full schema in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-payment-pages/openapi"},"children":["API reference"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"store-a-card","__idx":6},"children":["Store a card"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can save your customer's card as part of a payment request by creating a token which you can use to take subsequent payments."," ","These subsequent payments are distinguished between two core transaction types:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customer Initiated Transactions"]}," (CITs)",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Definition:"]}," The customer is present and actively involved in the transaction. This is also known as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardOnFile"]}," in the API request."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]},": Storing card details (card on file) with an online retailer for future use."]}]}]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Merchant Initiated Transactions"]}," (MITs)",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Definition:"]}," The merchant initiates the transaction without the customer being actively involved at that moment. This is also known as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscription"]}," in the API request."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples:"]}," Subscriptions, installments, delayed charges, no-show fees."]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Visit our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/articles/stored-credentials"},"children":["stored credentials article"]}," for an overview of Customer Initiated Transactions and Merchant Initiated Transactions."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With our Hosted Payment Pages API you can setup MIT agreements and take a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["first"]}," payment. To manage your agreement and take subsequent payments, you must use a direct integration through our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payments/recurring-subsequent"},"children":["Payments API"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"examples","__idx":7},"children":["Examples"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"CIT - all fields","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/hosted-payment-pages/@v1/openapi.yaml","operationId":"create","exampleKey":"Store a Card - card on file (all fields)","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"MIT - all fields","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/hosted-payment-pages/@v1/openapi.yaml","operationId":"create","exampleKey":"Store a Card - subscription (all fields)","parameters":{},"environments":{}},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters","__idx":8},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required?"},"children":["Required?"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createToken"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that instructs us to create a token for the payment details supplied."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of token. The value is \"worldpay\"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["namespace"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A namespace is used to group up to 16 cards, e.g. for one customer. A card can exist in more than one namespace."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A description of your token. If not supplied, a default description is created for you."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["optIn"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["\"Silent\""]}," - (default value) The card details will always be saved (you must already have their consent to do this)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["\"Notify\""]}," - The card details will always be saved (you must already have their consent to do this) and your customer will see this within our hosted payment pages"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["\"Ask\""]}," - The card details will be 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. "]}]}," ",{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[" If your customer does not consent, then no card details are saved. "]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The below table contains fields required to setup a repeat agreement."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required?"},"children":["Required?"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerAgreement"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that contains specific customer agreements for the transaction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["storedCardUsage"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defines when in the agreement the card is used",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["first"]}," - use this when initially storing a card. Applicable when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"cardOnFile\""]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"subscription\""]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[" ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subsequent"]}," - Use this when taking payment with a previously stored card. Only applicable for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"cardOnFile\""]},"."]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The processing arrangement agreed with your customer. ",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"cardOnFile\""]}," - Use this for Cardholder Initiated Transactions (CITs)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"subscription\""]}," - 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 ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payments/openapi"},"children":["Payments API"]},"."]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["View the full schema in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-payment-pages/openapi"},"children":["API reference"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We return the token via a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-payment-pages/webhooks#webhook-values-for-tokencreated"},"children":["webhook"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"take-a-payment-from-a-stored-card-cit","__idx":9},"children":["Take a payment from a stored card (CIT)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use a previously stored card to take a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardOnFile"]}," payment. We capture the CVC as part of this flow."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"examples-1","__idx":10},"children":["Examples"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Mandatory fields only","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/hosted-payment-pages/@v1/openapi.yaml","operationId":"create","exampleKey":"Take Payment from a Stored Card -card on file (mandatory fields)","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"All fields","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/hosted-payment-pages/@v1/openapi.yaml","operationId":"create","exampleKey":"Take Payment from a Stored Card - card on file (all fields)","parameters":{},"environments":{}},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that contains the payment type and details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payment type details. Value is \"card/tokenized\"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["href"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["We return this after token creation via the webhook."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"optionalconditional-parameters","__idx":11},"children":["Optional/conditional parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We handle 3DS authentication and fraud assessments on your behalf. However, supplying the additional optional fields below, increases the chance of a frictionless flow for your customer."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The result URLs are required to redirect your customer to your defined URL at the end of their payment journey."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required?"},"children":["Required?"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data type"},"children":["Data type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field length"},"children":["Field length"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An optional text, when supplied is displayed to your customer on payment pages."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum of 128 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object containing the billingAddress information."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress.firstName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer's first name."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum of 22 characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress.lastName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer's last name."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum of 22 characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress.address1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only required when billing address is provided."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum of 85 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress.address2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only required when billing address is provided."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum of 85 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress.address3"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only required when billing address is provided."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum of 85 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress.postalCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only required when billing address is provided."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum of 15 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress.city"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only required when billing address is provided."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum of 50 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress.state"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only required when billing address is provided.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," For the United States or China (must be ISO-3611-2, only provide two characters after \"US-\" or \"CN-\", e.g. FL for Florida or BJ for Beijing)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum of 50 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress.countryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only required when billing address is provided."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be a valid ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/supported-countries-currencies#iso-country-codes"},"children":["ISO3166-1 alpha-2 country code"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resultURLs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resultURLs.successURL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When we receive the payment result for a successful payment, we redirect your customer to the success URL."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resultURLs.pendingURL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When we receive the payment result for a pending payment transaction, we redirect your customer to the pending URL."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resultURLs.failureURL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When a payment fails, we redirect your customer to the failure URL."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resultURLs.errorURL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When we receive the payment result for an erroneous payment, we redirect your customer to the error URL."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resultURLs.cancelURL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When your customer cancels a transaction, we redirect that customer to the cancel URL."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resultURLs.expiryURL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When a customer leaves the payment transaction uncompleted within the maximum allowed time frame, we redirect your customer to the expiry URL."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object containing all data that can be used to configure manual fraud rules."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom.string1-9"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["9 available slots for custom string values you can use to configure manual fraud rules."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["To increase the chances of a frictionless flow, we recommend sending additional data in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskData"]}," object."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlement"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object containing information relating to whether auto settlement is turned on or off."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settlement.auto"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A value when specified allows you to turn auto settlement off. The default behaviour is always on and there is nothing to specify."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelOn"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object containing configuration for when a payment is sent for cancellation automatically."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelOn.cvcNotMatched"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A value when specified allows you to continue to sent for settlement. By default a payment will be sent for cancellation if the CVC is not matched and there is nothing to specify for the default behaviour."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expiry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allows you to configure the duration your customer can access the payment link. If not provided, defaults to 3600 seconds."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["min 300 seconds - max 2,592,000 seconds"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customisation_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A unique value generated by us that represents ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-payment-pages/configuration#select-channel"},"children":["the channel in the Payment Page Designer"]},". If not sent, the \"default\" channel settings apply. You can overwrite individual customization styles and properties by using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hostedCustomization"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hostedProperties"]}," objects."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["21 characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locale"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When we receive one of the supported locale values, the payment pages are loaded in the language of the locale. If locale is not specified, the payment pages load in English."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum of 5 characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hostedCustomization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object containing CSS customization."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hostedProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object containing functional properties customization."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"risk-data","__idx":12},"children":["Risk data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are three ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskData"]}," objects you can include in your request:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"account","__idx":13},"children":["Account"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object containing all customer account related risk data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.previousSuspiciousActivity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["true"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["false"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["guestUser"]}," - Order placed without full merchant account registration (no password) "]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registeredUser"]},"- Order placed with full merchant account registration (password entered)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["federatedAccount"]}," - Using a Federated ID "]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issuerCredentials"]},"- Using issuer credentials"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["thirdPartyAuthentication"]}," - Using third party authentication"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fidoAuthenticator"]}," - FIDO authentication standard"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The customer's email address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.history.createdAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the account was created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.history.modifiedAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the account was last modified."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.history.passwordModifiedAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the account password was last changed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.history.paymentAccountEnrolledAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date the payment account was added to the cardholder account."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"transaction","__idx":14},"children":["Transaction"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object containing all customer transaction related risk data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction.reorder"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Repeat of a previous order :",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["true"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["false"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction.preOrderDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expected date that a pre-ordered purchase will be available."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction.firstName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer's first name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction.lastName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer's last name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction.phoneNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer's phone number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction.history"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object containing details of the last transaction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["history.attemptsLastDay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["history.attemptsLastYear"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of transactions (successful or abandoned) for this cardholder account within the last year."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["history.completedLastSixMonths"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of purchases with this customer account during the previous six months."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["history.addCardsLastDay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of attempts to add a card in the last 24hrs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["history.shippingAddressFirstUsedAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the shipping address used for the transaction was first used."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction.giftCardsPurchase"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If the order is being used to purchase a gift card."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["giftCardsPurchase.totalValue.currency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The three digit currency code. See list of [supported currencies. If provided must include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalValue.amount"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["giftCardsPurchase.totalValue.amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The amount being placed on the gift card. If provided, must include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalValue.currency"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["giftCardsPurchase.quantity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The number of gift cards being purchased."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction.threeDS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object containing information relating to whether 3DS is turned off."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["threeDS.type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A value allowing you to turn off 3DS. The default is \"on\"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction.fraud"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object containing information relating to whether FraudSight is turned off."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fraud.type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A value allowing you to turn off FraudSight. The default is \"on\"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"shipping","__idx":15},"children":["Shipping"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipping"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Object containing all data related to how the order will be shipped."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipping.nameMatchesAccountName"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Customer name on account is identical to the shipping name:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["true"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["false"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipping.method"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billingAddress"]}," - Ship to customer's billing address"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["verifiedAddress"]}," - Ship to another verified address on file with merchant"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["otherAddress"]}," - Ship to address that is different than billing address"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["store"]}," - Ship to store (store address should be populated on request)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["digital"]}," - Digital goods"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unshippedTickets"]}," - Travel and event tickets, not shipped"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["other"]}," - Other"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipping.timeFrame"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["electronic"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sameDay"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextDay"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["twoDaysPlus"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipping.email"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An object containing the shipping address information."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["If included, you must send"]}," at least:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["city"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postalCode"]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example","__idx":16},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/request-all.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n \"transactionReference\": \"MyTransaction123\",\n \"merchant\": {\n \"entity\": \"POxxxxxxxxx\"\n },\n \"narrative\": {\n \"line1\": \"line1\"\n },\n \"value\": {\n \"currency\": \"GBP\",\n \"amount\": 123\n },\n \"description\": \"Mind Palace Ltd\",\n \"billingAddressName\": \"Sherlock Holmes\",\n \"billingAddress\": {\n \"firstName\": \"John\",\n \"lastName\": \"Watson\",\n \"address1\": \"221B Baker Street\",\n \"address2\": \"Marylebone\",\n \"address3\": \"Westminster\",\n \"postalCode\": \"NW1 6XE\",\n \"city\": \"London\",\n \"state\": \"Greater London\",\n \"countryCode\": \"GB\"\n },\n \"resultURLs\": {\n \"successURL\": \"https://mindpalace-website/result/success\",\n \"pendingURL\": \"https://mindpalace-website/result/pending\",\n \"failureURL\": \"https://mindpalace-website/result/failure\",\n \"errorURL\": \"https://mindpalace-website/result/error\",\n \"cancelURL\": \"https://mindpalace-website/result/cancel\",\n \"expiryURL\": \"https://mindpalace-website/result/expiry\"\n },\n \"riskData\": {\n \"shipping\": {\n \"firstName\": \"James\",\n \"lastName\": \"Moriarty\",\n \"address\": {\n \"city\": \"Durham\",\n \"address1\": \"The Palatine Centre\",\n \"address2\": \"Durham University\",\n \"address3\": \"Stockton Road\",\n \"state\": \"County Durham\",\n \"countryCode\": \"GB\",\n \"postalCode\": \"DH1 3LE\",\n \"phoneNumber\": \"01189998819999197253\"\n },\n \"method\": \"verifiedAddress\",\n \"nameMatchesAccountName\": false,\n \"email\": \"james.moriarty@example.com\",\n \"timeFrame\": \"nextDay\"\n },\n \"custom\": {\n \"string1\": \"foo\",\n \"number1\": \"1\",\n \"string2\": \"foo\",\n \"number2\": \"1\",\n \"string3\": \"foo\",\n \"number3\": \"1\",\n \"string4\": \"foo\",\n \"number4\": \"1\",\n \"string5\": \"foo\",\n \"number5\": \"1\",\n \"string6\": \"foo\",\n \"number6\": \"1\",\n \"string7\": \"foo\",\n \"number7\": \"1\",\n \"string8\": \"foo\",\n \"number8\": \"1\",\n \"string9\": \"foo\",\n \"number9\": \"1\"\n },\n \"account\": {\n \"shopperId\": \"1234\",\n \"dateOfBirth\": \"1835-04-01\",\n \"history\": {\n \"createdAt\": \"1876-06-01\",\n \"modifiedAt\": \"1876-08-13\",\n \"paymentAccountEnrolledAt\": \"1876-06-01\",\n \"passwordModifiedAt\": \"1876-06-01\"\n },\n \"type\": \"fidoAuthenticator\",\n \"previousSuspiciousActivity\": false,\n \"email\": \"sherlock.holmes@example.com\"\n },\n \"transaction\": {\n \"firstName\": \"James\",\n \"lastName\": \"Moriarty\",\n \"phoneNumber\": \"01189998819999197253\",\n \"preOrderDate\": \"1876-08-13\",\n \"reorder\": false,\n \"history\": {\n \"attemptsLastYear\": 3,\n \"completedLastSixMonths\": 4,\n \"attemptsLastDay\": 2,\n \"shippingAddressFirstUsedAt\": \"1876-06-01\",\n \"addCardsLastDay\": 1\n },\n \"giftCardsPurchase\": {\n \"totalValue\": {\n \"amount\": 10000,\n \"currency\": \"GBP\"\n },\n \"quantity\": 1\n }\n }\n },\n \"hostedCustomization\": {\n \"backgroundColor\": \"#FFFFFF\",\n \"color\": \"#000000\",\n \"page\": {\n \"backgroundColor\": \"#333333\",\n \"color\": \"#FFFFFF\",\n \"border\": {\n \"color\": \"#CCCCCC\",\n \"width\": \"1px\",\n \"style\": \"solid\",\n \"radius\": \"4px\"\n },\n \"fonts\": {\n \"family\": [\"Comic Sans MS\"]\n }\n },\n \"buttons\": {\n \"backgroundColor\": \"#FF0\",\n \"color\": \"#333333\",\n \"border\": {\n \"style\": \"solid\",\n \"color\": \"#0FF\",\n \"width\": \"3px\",\n \"radius\": \"0px\"\n },\n \"fonts\": {\n \"family\": [\"Comic Sans MS\"]\n },\n \"hover\": {\n \"backgroundColor\": \"#DDF\",\n \"color\": \"#111111\",\n \"border\": {\n \"color\": \"#BBBBBB\",\n \"width\": \"2px\",\n \"style\": \"dotted\",\n \"radius\": \"0px\"\n },\n \"fonts\": {\n \"family\": [\"Comic Sans MS\"]\n }\n },\n \"focus\": {\n \"backgroundColor\": \"#DFD\",\n \"color\": \"#222222\",\n \"border\": {\n \"color\": \"#CCCCCC\",\n \"width\": \"2px\",\n \"style\": \"solid\",\n \"radius\": \"0px\"\n },\n \"fonts\": {\n \"family\": [\"Comic Sans MS\"]\n }\n }\n },\n \"inputs\": {\n \"backgroundColor\": \"#FFFFFF\",\n \"color\": \"#000000\",\n \"border\": {\n \"style\": \"solid\",\n \"width\": \"2px\",\n \"radius\": \"2px\",\n \"color\": \"#FFF\"\n },\n \"fonts\": {\n \"family\": [\"Comic Sans MS\"]\n },\n \"placeholder\": {\n \"color\": \"#001\"\n },\n \"validation\": {\n \"ok\": {\n \"color\": \"#00F\"\n },\n \"error\": {\n \"color\": \"#F00\"\n }\n },\n \"hover\": {\n \"backgroundColor\": \"#FF0000\",\n \"color\": \"#7F0000\",\n \"border\": {\n \"color\": \"#0FF\",\n \"width\": \"1px\",\n \"style\": \"solid\",\n \"radius\": \"2px\"\n },\n \"fonts\": {\n \"family\": [\"Comic Sans MS\"]\n },\n \"placeholder\": {\n \"color\": \"#AAAAAA\"\n },\n \"validation\": {\n \"ok\": {\n \"color\": \"#00CC00\"\n },\n \"error\": {\n \"color\": \"#CC0000\"\n }\n }\n },\n \"focus\": {\n \"backgroundColor\": \"#0240FF\",\n \"color\": \"#001F7F\",\n \"border\": {\n \"color\": \"#0FF\",\n \"width\": \"1px\",\n \"style\": \"solid\",\n \"radius\": \"2px\"\n },\n \"fonts\": {\n \"family\": [\"Comic Sans MS\"]\n },\n \"placeholder\": {\n \"color\": \"#BBBBBB\"\n },\n \"validation\": {\n \"ok\": {\n \"color\": \"#009900\"\n },\n \"error\": {\n \"color\": \"#990000\"\n }\n }\n }\n },\n \"fonts\": {\n \"family\": [\"Comic Sans MS\"]\n }\n },\n \"hostedProperties\": {\n \"showBillingAddress\": \"EDIT\",\n \"showShippingAddress\": \"HIDE\",\n \"showCountryList\": \"false\",\n \"showLanguageList\": \"false\",\n \"showContactDetails\": \"HIDE\",\n \"sendURLParameters\": \"true\",\n \"showPoweredByWorldPay\": \"true\",\n \"showCancelButton\": \"true\",\n \"showChangePaymentMethodButton\": \"false\",\n \"disableStrictUrls\": \"true\",\n \"showHeader\": \"true\",\n \"showFooter\": \"true\",\n \"showCardIcons\": \"false\",\n \"paymentButtonLabel\": \"makePayment\",\n \"showCardholderName\": \"true\",\n \"showPaymentDetailsHeader\": \"true\",\n \"passBackErrorReasons\": \"true\",\n \"maskCardDetails\": \"false\",\n \"googlePayButtonColour\": \"black\",\n \"googlePayButtonLabel\": \"long\",\n \"applePayButtonType\": \"plain\",\n \"applePayButtonStyle\": \"black\"\n },\n \"settlement\": {\n \"auto\": true,\n \"cancelOn\": {\n \"cvcNotMatched\": \"disabled\"\n }\n },\n \"expiry\": \"600\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pay-by-link","__idx":17},"children":["Pay by Link"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can create a payment link to send to your customers by setting an expiry date of the redirect URL in your payment request."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Format"},"children":["Format"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expiry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allows you to configure the duration, in seconds, your customer can access the payment link."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["int64, 300 - 2592000, Default: 3600"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-1","__idx":18},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n\t\"transactionReference\": \"MyTransaction123\",\n\t\"merchant\": {\n\t\t\"entity\": \"POxxxxxxxxxx\"\n\t},\n\t\"narrative\": {\n\t\t\"line1\": \"Mind Palace Ltd\"\n\t},\n\t\"value\": {\n\t\t\"currency\": \"GBP\",\n\t\t\"amount\": 123\n\t},\n\t\"expiry\": \"600\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you are a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Worldpay eCommerce (SMB) customer"]}," you can also create Pay by Link URLs in your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.worldpay.com/"},"children":["dashboard"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","The ability to create Pay by Link URLs through a dashboard for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enterprise customers"]}," is coming soon."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"google-pay","__idx":19},"children":["Google Pay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To offer Google Pay on Pay by Link you must set your domain in your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.worldpay.com/"},"children":["dashboard"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response","__idx":20},"children":["Response"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Success","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/response.json","header":{"controls":{"copy":{}}},"source":"{\n \"url\": \"https://payments.worldpay.com/app/hpp/integration/transaction/xxxxxxxxxxxxxxxxxxxx&cs=yyyyyy\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://access.worldpay.com/paymentQueries/payments?transactionReference=174420000000000\"\n }\n }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Error response","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/response-500.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n \"errorName\": \"internalErrorOccurred\",\n \"message\": \"An internal problem occurred with your request, please try again.\"\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]}," to redirect your customer to the payment pages and complete the payment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["href"]}," to query for next action links once a payment has been made"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Worldpay's Hosted Payment Pages use and switch traffic between multiple domains. To prevent disruptions in service, do not whitelist domains."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In case of an error, you can get further information in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/worldpay-error-responses"},"children":["error reference"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next steps"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-payment-pages/redirect-your-customer"},"children":["Redirect your customer"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]}]},"headings":[{"value":"Setup a payment","id":"setup-a-payment","depth":1},{"value":"Integration overview","id":"integration-overview","depth":2},{"value":"Set your headers","id":"set-your-headers","depth":2},{"value":"Take a guest card payment","id":"take-a-guest-card-payment","depth":2},{"value":"Example with mandatory fields:","id":"example-with-mandatory-fields","depth":4},{"value":"Mandatory parameters","id":"mandatory-parameters","depth":3},{"value":"Store a card","id":"store-a-card","depth":2},{"value":"Examples","id":"examples","depth":4},{"value":"Parameters","id":"parameters","depth":3},{"value":"Take a payment from a stored card (CIT)","id":"take-a-payment-from-a-stored-card-cit","depth":2},{"value":"Examples","id":"examples-1","depth":4},{"value":"Optional/conditional parameters","id":"optionalconditional-parameters","depth":3},{"value":"Risk data","id":"risk-data","depth":3},{"value":"Account","id":"account","depth":4},{"value":"Transaction","id":"transaction","depth":4},{"value":"Shipping","id":"shipping","depth":4},{"value":"Example","id":"example","depth":4},{"value":"Pay by Link","id":"pay-by-link","depth":2},{"value":"Example","id":"example-1","depth":4},{"value":"Google Pay","id":"google-pay","depth":4},{"value":"Response","id":"response","depth":2}],"frontmatter":{"seo":{"title":"Setup a payment"}},"lastModified":"2026-06-04T15:37:16.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/hosted-payment-pages/setup-a-payment","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}