{"templateId":"markdown","versions":[{"version":"v5","label":"v5","link":"/products/card-payments/v5/authorize-a-payment","default":false,"active":true,"folderId":"5e391095"},{"version":"v6","label":"v6","link":"/products/card-payments/v6/authorize-a-payment","default":false,"active":false,"folderId":"5e391095"},{"version":"v7","label":"v7 (Latest)","link":"/products/card-payments/authorize-a-payment","default":true,"active":false,"folderId":"5e391095"}],"sharedDataIds":{"sidebar":"sidebar-products/card-payments/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/card-payments/openapi"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition","tabs","tab","code-snippet"]},"custom_product":"Card Payments","type":"markdown"},"seo":{"title":"Take 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-bsh.securedataplatform.co.uk","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-bsh.securedataplatform.co.uk/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/**/*"]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"]},{"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/**/*"]},{"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/**/*"]},{"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/**/*"]},{"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/**/*"]},{"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/**/*"]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"]},{"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/**/*"]},{"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/**/*"]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"]},{"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/**/*"]}]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 01 September 2026 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"take-a-payment","__idx":0},"children":["Take a payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To take a payment, you must first create an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#authorization-request"},"children":["authorization request"]},". Your response contains links to your next available actions."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authorize-a-payment","__idx":1},"children":["Authorize a payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you want to reserve funds in your customer's account, send us an authorization request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," your authorization request to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:authorize"]}," action link received in your root resource response to authorize a payment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authorization-example-request","__idx":2},"children":["Authorization example request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The requests below contain all the ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["mandatory"]}," fields needed for a successful authorization request."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click the tabs below to see all the mandatory fields for all supported ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument"]}," parameters."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Authorization request body:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Card","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-card.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"John Appleseed\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 5,\n                \"year\": 2035\n            }\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS1 Card","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-3ds1-card.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"John Appleseed\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 5,\n                \"year\": 2035\n            }\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"1.0.2\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"z9UKb06xLziZMOXBEmWSVA1kwG0=\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS2 Card","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-3ds2-card.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"John Appleseed\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 5,\n                \"year\": 2035\n            }\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"2.1.0\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"683001f5-3805-423a-b580-638e4b2093b\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS1 Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-3ds1-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\"\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"1.0.2\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"z9UKb06xLziZMOXBEmWSVA1kwG0=\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS2 Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-3ds2-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\"\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"2.1.0\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"683001f5-3805-423a-b580-638e4b2093b\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Apple Pay","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-apple-pay.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/wallet+applepay\",\n            \"walletToken\": \"{\n                \\\"version\\\": \\\"EC_v1\\\",\n                \\\"data\\\": \\\"kdHd..GQ==\\\",\n                \\\"signature\\\": \\\"MIAGCSqGSIb3DQEH...AAA\\\",\n                \\\"header\\\": {\n                    \\\"transactionId\\\": \\\"d3b28af..f8\\\",\n                    \\\"ephemeralPublicKey\\\": \\\"MFkwE..Q==\\\",\n                    \\\"publicKeyHash\\\": \\\"dxCK..6o=\\\" \n                }\n            }\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Google Pay","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-google-pay.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/wallet+googlepay\",\n            \"walletToken\": \"{\\\"protocolVersion\\\":\\\"ECv1\\\",\\\"signature\\\":\\\"MEQCIH6Q4OwQ0jAceFEkGF0JID6sJNXxOEi4r+mA7biRxqBQAiAondqoUpU/bdsrAOpZIsrHQS9nwiiNwOrr24RyPeHA0Q\\\\u003d\\\\u003d\\\",\\\"signedMessage\\\":\\\"{\\\\\\\"tag\\\\\\\":\\\\\\\"jpGz1F1Bcoi/fCNxI9n7Qrsw7i7KHrGtTf3NrRclt+U\\\\\\\\u003d\\\\\\\",\\\\\\\"ephemeralPublicKey\\\\\\\":\\\\\\\"BJatyFvFPPD21l8/uLP46Ta1hsKHndf8Z+tAgk+DEPQgYTkhHy19cF3h/bXs0tWTmZtnNm+vlVrKbRU9K8+7cZs\\\\\\\\u003d\\\\\\\",\\\\\\\"encryptedMessage\\\\\\\":\\\\\\\"mKOoXwi8OavZ\\\\\\\"}\\\"}\"\n        }\n    }\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"descriptions-of-your-authorization-request-parameters","__idx":3},"children":["Descriptions of your authorization request 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":"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":["transactionReference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["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#transaction-reference-format"},"children":["transaction reference format"]},", for more details and the best practices."]}]},{"$$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":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that contains information about the merchant."]}]},{"$$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":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication and queries.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Contact your Worldpay Implementation Manager for more details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instruction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that contains all the information related to the payment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instruction.narrative"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The text that appears on your customer's statement. Used to identify the merchant.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/formatting#narrative-format"},"children":["narrative format"]},"for more details and best practices."]}]},{"$$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":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The first line of the narrative which appears on your customer's statement (24 characters max. If character is not supported it is replaced with a space.).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/formatting#narrative-line1"},"children":["narrative ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line1"]}," format"]}," for more details."]}]},{"$$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":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The three digit currency code.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"See list of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/useful-tables-v5-v6#currency-codes"},"children":["supported currencies"]},"."]}]},{"$$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":["✅"]},{"$$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/useful-tables-v5-v6#currency-codes"},"children":["currency table"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instruction.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":"br","attributes":{},"children":[]}," To use \"tokens\" as a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument"]}," you must first [create a token](",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," s/create-a-token). To use \"checkout with CVC\" (card on file only) as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument"]}," you must first use our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/checkout/web"},"children":["checkout SDK"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/verified-tokens/create-verified-token"},"children":["create a token"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3ds","__idx":4},"children":["3DS"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["3DS authorization request parameter descriptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customer"]}," authentication object you must complete an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/3ds/web/authentication"},"children":["authentication request"]}," using our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/3ds"},"children":["3DS API"]},"."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS1 Card","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-3ds1-card.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"John Appleseed\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 5,\n                \"year\": 2035\n            }\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"1.0.2\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"z9UKb06xLziZMOXBEmWSVA1kwG0=\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS2 Card","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-3ds2-card.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"John Appleseed\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 5,\n                \"year\": 2035\n            }\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"2.1.0\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"683001f5-3805-423a-b580-638e4b2093b\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS1 Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-3ds1-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\"\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"1.0.2\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"z9UKb06xLziZMOXBEmWSVA1kwG0=\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS2 Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/requests/authorization-request-3ds2-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\"\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"2.1.0\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"683001f5-3805-423a-b580-638e4b2093b\"\n        }\n    }\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"the-descriptions-of-parameters-from-your-3ds-authorization-request","__idx":5},"children":["The descriptions of parameters from your 3DS authorization 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":"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":["customer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object containing the result of your customer's verification. For more details see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/3ds/web/challenge-verification"},"children":["3DS verification"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authentication.type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3DS"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authentication.version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The version of 3DS used to process the transaction.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"For 3DS1 - ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1.0.2"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"For 3DS2 - ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2.1.0"]}," or  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2.2.0"]}," ",{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[" Required for Mastercard's Identity Check transactions in Authorization."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authentication.eci"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Electronic Commerce Indicator (ECI).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Indicates the outcome of the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/3ds/web/challenge-verification"},"children":["3DS verification"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["02 or 05 - Fully Authenticated Transaction"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["01 or 06 - Attempted Authentication Transaction"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["00 or 07 - Non 3-D Secure Transaction"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Mastercard"]}," - 02, 01, 00"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Visa"]}," - 05, 06, 07"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Amex"]}," - 05, 06, 07"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["JCB"]}," - 05, 06, 07"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Diners"]}," - 05, 06, 07"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authentication.authenticationValue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A cryptographic value that provides evidence of the outcome of a 3DS verification.",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Visa - Cardholder Authentication Verification Value (CAVV)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Mastercard - Universal Cardholder Authentication Field (UCAF)"]}]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authentication.authenticationValue"]}," must be 28 digits max and must be base64-encoded."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authentication.transactionId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required, if ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authentication.eci"]}," value is 01, 02, 05 or 06.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"A unique authentication transaction identifier, generated by the issuer.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"For version 3DS1: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionId"]}," must be base64-encoded and  28 digits in length.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"For version 3DS2: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionId"]}," must be a UUID and 36 characters in length."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"optional-fields-in-an-authorization-request","__idx":6},"children":["Optional fields in an authorization request"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Optional fields and descriptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The requests below contain all the ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["mandatory and optional"]}," fields needed for a successful authorization request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"complete-authorization-request-schema","__idx":7},"children":["Complete authorization request schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full authorization request body:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Card All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/all/requests/authorization-request-all-card.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1234\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"debtRepayment\": true,\n        \"narrative\": {\n            \"line1\": \"trading name\",\n            \"line2\": \"order number\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"cvc\": \"123\",\n            \"billingAddress\": {\n                \"address1\": \"Worldpay\",\n                \"address2\": \"1 Milton Road\",\n                \"address3\": \"The Science Park\",\n                \"postalCode\": \"CB4 0WE\",\n                \"city\": \"Cambridge\",\n                \"state\": \"Cambridgeshire\",\n                \"countryCode\": \"GB\"\n            },\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"John Appleseed\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 5,\n                \"year\": 2035\n            }\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Token All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/all/requests/authorization-request-all-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1000\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"debtRepayment\": true,\n        \"narrative\": {\n            \"line1\": \"trading name\",\n            \"line2\": \"order number\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\",\n            \"cvc\": \"898\"\n\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS1 Card All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/all/requests/authorization-request-all-card-3ds1.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1234\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"debtRepayment\": true,\n        \"narrative\": {\n            \"line1\": \"trading name\",\n            \"line2\": \"order number\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"cvc\": \"123\",\n            \"billingAddress\": {\n                \"address1\": \"Worldpay\",\n                \"address2\": \"1 Milton Road\",\n                \"address3\": \"The Science Park\",\n                \"postalCode\": \"CB4 0WE\",\n                \"city\": \"Cambridge\",\n                \"state\": \"Cambridgeshire\",\n                \"countryCode\": \"GB\"\n            },\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"John Appleseed\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 5,\n                \"year\": 2035\n            }\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"1.0.2\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"z9UKb06xLziZMOXBEmWSVA1kwG0=\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS2 Card All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/all/requests/authorization-request-all-card-3ds2.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1234\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"debtRepayment\": true,\n        \"narrative\": {\n            \"line1\": \"trading name\",\n            \"line2\": \"order number\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"cvc\": \"123\",\n            \"billingAddress\": {\n                \"address1\": \"Worldpay\",\n                \"address2\": \"1 Milton Road\",\n                \"address3\": \"The Science Park\",\n                \"postalCode\": \"CB4 0WE\",\n                \"city\": \"Cambridge\",\n                \"state\": \"Cambridgeshire\",\n                \"countryCode\": \"GB\"\n            },\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"John Appleseed\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 5,\n                \"year\": 2035\n            }\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"2.1.0\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"683001f5-3805-423a-b580-638e4b2093b\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS1 Token All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/all/requests/authorization-request-all-3ds1-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1000\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"debtRepayment\": true,\n        \"narrative\": {\n            \"line1\": \"trading name\",\n            \"line2\": \"order number\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\",\n            \"cvc\": \"898\"\n\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"1.0.2\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"z9UKb06xLziZMOXBEmWSVA1kwG0=\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS2 Token All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/all/requests/authorization-request-all-3ds2-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1000\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        },\n        \"instruction\": {\n            \"debtRepayment\": true,\n            \"narrative\": {\n                \"line1\": \"trading name\",\n                \"line2\": \"order number\"\n            },\n            \"value\": {\n                \"currency\": \"GBP\",\n                \"amount\": 250\n            },\n            \"paymentInstrument\": {\n                \"type\": \"card/token\",\n                \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\",\n                \"cvc\": \"898\"\n\n            }\n        },\n        \"customer\": {\n            \"authentication\": {\n                \"version\": \"2.1.0\",\n                \"type\": \"3DS\",\n                \"eci\": \"05\",\n                \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n                \"transactionId\": \"683001f5-3805-423a-b580-638e4b2093b\"\n            }\n        }\n    }\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"additional-parameter-descriptions","__idx":8},"children":["Additional parameter descriptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The descriptions of the additional parameters in your complete authorization 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":"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":["narrative.line2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional details about the payment e.g. order number, telephone number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.billingAddress"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object containing the billing 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"]}]}]}," This is used for Address Verification Service (AVS). Our API checks the submitted AVS to see if it matches the address registered with the issuing bank. If the address supplied does not match the registered address it means that the payment carries additional risk."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant.mcc"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You can apply a merchant category code (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mcc"]},") to an individual request. You can only provide an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mcc"]}," if we have enabled the dynamic mcc feature during ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.worldpay-bsh.securedataplatform.co.uk/en-GB/merchant-support#still-need-help"},"children":["boarding"]},". If enabled but not provided, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant.mcc"]}," defaults to a configured value. For more information contact your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.worldpay-bsh.securedataplatform.co.uk/en-GB/merchant-support#still-need-help"},"children":["Relationship Manager"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.cvc"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CVC is a unique set of 3 or 4 numbers on the back of the card.  Our API checks to see if the CVC supplied matches the CVC held by the issuing bank."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant.paymentFacilitator"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object containing Payment Facilitator information.  ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["If required you must send"]},":",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pfId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isoId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.merchantId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.postalcode"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.street"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.city"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.countryCode"]}]}]}," This information is required for every authorization ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["only if you are a Payment Facilitator"]},". You can find more formatting information ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/formatting#payment-facilitator-format"},"children":["here"]},"."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Check out our API reference for more information on the Authorization request and schema for each version of our Payments API."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authorization-response","__idx":9},"children":["Authorization response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"successful-payment","__idx":10},"children":["Successful payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an HTTP code ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"outcome\": \"authorized\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["risk factors (only returned if issuer identifies conflict)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an issuer authorization code"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["links to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#cancel-an-authorization"},"children":["cancel"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#settle-an-authorization"},"children":["settle"]}," , ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#partially-settle-an-authorization"},"children":["partially settle"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/query-a-payment"},"children":["query"]}," your payment"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"refused-payment","__idx":11},"children":["Refused payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an HTTP code ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"outcome\": \"refused\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/refusal-response"},"children":["refusal code"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," which gives additional context on the refusal"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response","__idx":12},"children":["Example response"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Card/Token/3DS1/3DS2","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/all/responses/authorization-response-all.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"outcome\": \"authorized\",\n    \"riskFactors\": [{\n            \"risk\": \"not_matched\",\n            \"type\": \"cvc\"\n        },\n        {\n            \"risk\": \"not_checked\",\n            \"detail\": \"postcode\",\n            \"type\": \"avs\"\n        },\n        {\n            \"risk\": \"not_matched\",\n            \"detail\": \"address\",\n            \"type\": \"avs\"\n        }\n    ],\n    \"issuer\": {\n        \"authorizationCode\": \"0\"\n    },\n    \"_links\": {\n        \"payments:cancel\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:settle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/full/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:partialSettle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/partials/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:events\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/events/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"curies\": [{\n            \"name\": \"payments\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payments/{rel}\",\n            \"templated\": true\n        }]\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Apple Pay/Google Pay","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/responses/authorization-response.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"outcome\": \"authorized\",\n    \"issuer\": {\n        \"authorizationCode\": \"0\"\n    },\n    \"_links\": {\n        \"payments:cancel\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:settle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/full/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:partialSettle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/partials/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:events\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/events/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"curies\": [{\n            \"name\": \"payments\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payments/{rel}\",\n            \"templated\": true\n        }]\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Refusal","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/responses/authorization-response-refused.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"outcome\": \"refused\",\n    \"description\": \"CARD EXPIRED\",\n    \"code\": \"33\",\n    \"riskFactors\": [{\n            \"risk\": \"not_supplied\",\n            \"type\": \"cvc\"\n        },\n        {\n            \"risk\": \"not_checked\",\n            \"detail\": \"address\",\n            \"type\": \"avs\"\n        },\n        {\n            \"risk\": \"not_checked\",\n            \"detail\": \"postcode\",\n            \"type\": \"avs\"\n        }\n    ]\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:settle"]}," action link to  ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#settle-an-authorization"},"children":["settle the payment"]}," straight away. Alternatively you can cache the response and use the link to settle the payment later."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"riskfactors","__idx":13},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskFactors"]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Address and Card Verification"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To reduce the probability of processing a fraudulent payment, supply your customer's billing address and cvc in your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#complete-authorization-request-schema"},"children":["authorization request"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We check this with your customer's issuing bank and include any conflicts in our response."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskFactors"]}," array is returned ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["only if"]}," there is a risk associated with the authorization request. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskFactors"]}," array returns an object for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["avs"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cvc"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["only if"]}," this information was included in the authorization request ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["and"]}," if any risk was identified."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The table below describes the response 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":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskFactors.type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["avs"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cvc"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskFactors.detail"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["avs"]}," only.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postcode"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["riskFactors.risk"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["not_checked"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["not_matched"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["not_supplied"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"issuer","__idx":14},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issuer"]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Issuer"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Information returned by your customer's card issuer based on your authorization 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":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issuer.authorizationCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The authorization code returned by customer's card issuer."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"migraterecurring-authorization","__idx":15},"children":["migrateRecurring authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you need to make an existing recurring payment agreement compliant with the stored credentials mandate, use our ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:migrateRecurringAuthorize"]}," action link."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," your recurring authorization request to our ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:migrateRecurringAuthorize"]}," action link received in your root resource response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"migraterecurring-authorization-example-request","__idx":16},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateRecurring"]}," authorization example request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/migrateRecurring"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click the tabs below to see all the mandatory fields for all supported ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument"]}," parameters."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateRecurring"]}," authorization request body:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Card","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/recurring/requests/authorization-request-card.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"John Appleseed\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 5,\n                \"year\": 2035\n            }\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/recurring/requests/authorization-request-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\"\n        }\n    }\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Descriptions of your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateRecurring"]}," authorization request parameters can be found ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#descriptions-of-your-authorization-request-parameters"},"children":["here"]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["migrateRecurring authorization optional fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The requests below contain all the ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["mandatory and optional"]}," fields needed for a successful ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateRecurring"]}," authorization request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"complete-migraterecurring-authorization-request-schema","__idx":17},"children":["Complete ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateRecurring"]}," authorization request schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full migrateRecurring authorization request body:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Card","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/recurring/requests/authorization-request-all-card-recurring.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1234\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\",\n            \"line2\": \"order number\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"billingAddress\": {\n                \"address1\": \"Worldpay\",\n                \"address2\": \"1 Milton Road\",\n                \"address3\": \"The Science Park\",\n                \"postalCode\": \"CB4 0WE\",\n                \"city\": \"Cambridge\",\n                \"state\": \"Cambridgeshire\",\n                \"countryCode\": \"GB\"\n            },\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"John Appleseed\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 12,\n                \"year\": 2035\n            }\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/recurring/requests/authorization-request-all-token-recurring.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1000\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"test1\",\n            \"line2\": \"test2\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\"\n\n        }\n    }\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Descriptions of your full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateRecurring"]}," authorization request parameters can be found ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#additional-parameter-descriptions"},"children":["here"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"migraterecurring-response","__idx":18},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateRecurring"]}," response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"successful-payment-1","__idx":19},"children":["Successful payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an HTTP code ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"outcome\": \"authorized\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an issuer response code"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["links to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#cancel-an-authorization"},"children":["cancel"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#settle-an-authorization"},"children":["settle"]}," , ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#partially-settle-an-authorization"},"children":["partially settle"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/query-a-payment"},"children":["query"]}," your payment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an authorization link for the next payment in your recurring agreement"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"refused-payment-1","__idx":20},"children":["Refused payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an HTTP code ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"outcome\": \"refused\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an issuer response code"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," which gives additional context on the refusal"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-1","__idx":21},"children":["Example response"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Card/Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/recurring/responses/authorization-response.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"outcome\": \"authorized\",\n    \"issuer\": {\n        \"authorizationCode\": \"0\"\n    },\n    \"scheme\": {\n        \"reference\": \"1260019172\"\n    },\n    \"_links\": {\n        \"payments:cancel\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:settle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/full/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:partialSettle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/partials/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:events\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/events/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"curies\": [{\n            \"name\": \"payments\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payments/{rel}\",\n            \"templated\": true\n        }],\n        \"payments:CardOnFileAuthorize\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/CardOnFile/eyJrIjoiazNhYjYzMiJ9\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Card/Token All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/recurring/responses/authorization-response-all-recurring.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"outcome\": \"authorized\",\n    \"riskFactors\": [{\n            \"risk\": \"not_matched\",\n            \"type\": \"cvc\"\n        },\n        {\n            \"risk\": \"not_checked\",\n            \"detail\": \"postcode\",\n            \"type\": \"avs\"\n        },\n        {\n            \"risk\": \"not_checked\",\n            \"detail\": \"address\",\n            \"type\": \"avs\"\n        }\n    ],\n    \"issuer\": {\n        \"authorizationCode\": \"0\"\n    },\n    \"scheme \": {\n        \"reference\": \"1260019172\"\n    },\n    \"_links\": {\n        \"payments:cancel\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:settle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/full/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:partialSettle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/partials/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:events\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/events/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"curies\": [{\n            \"name\": \"payments\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payments/{rel}\",\n            \"templated\": true\n        }],\n        \"payments:CardOnFileAuthorize\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/CardOnFile/eyJrIjoiazNhYjYzMiJ9\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Refusal","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/authorize/responses/authorization-response-refused.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"outcome\": \"refused\",\n    \"description\": \"CARD EXPIRED\",\n    \"code\": \"33\",\n    \"riskFactors\": [{\n            \"risk\": \"not_supplied\",\n            \"type\": \"cvc\"\n        },\n        {\n            \"risk\": \"not_checked\",\n            \"detail\": \"address\",\n            \"type\": \"avs\"\n        },\n        {\n            \"risk\": \"not_checked\",\n            \"detail\": \"postcode\",\n            \"type\": \"avs\"\n        }\n    ]\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:settle"]}," action link to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#settle-an-authorization"},"children":["settle the payment"]}," straight away. Alternatively you can cache the response and use the link to settle the payment later."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You must always store and use the link returned in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:recurringAuthorize"]}," action link to authorize your next payment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"migratecardonfile-authorization","__idx":22},"children":["migrateCardOnFile authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Authorize new card on file payments whilst making them compliant. Migrate existing card on file agreements to a compliant environment whilst you send an authorization request."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This resource can only accept ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens"},"children":["tokens"]}," as a payment instrument."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," your card on file authorizations to our ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:migrateCardOnFileAuthorize"]}," action link resource received in your root resource response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"migratecardonfile-authorization-example-request","__idx":23},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateCardOnFile"]}," authorization example request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/migrateCardOnFile"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click the tabs below to see all the mandatory fields for all supported ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument"]}," parameters."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateCardOnFile"]}," authorization request body:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/requests/authorization-request-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\",\n            \"cvc\": \"898\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS1 Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/requests/authorization-request-3ds1-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\",\n            \"cvc\": \"898\"\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"1.0.2\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"z9UKb06xLziZMOXBEmWSVA1kwG0=\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS2 Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/requests/authorization-request-3ds2-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\",\n            \"cvc\": \"898\"\n        }\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"2.1.0\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"683001f5-3805-423a-b580-638e4b2093b\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Checkout with CVC","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/requests/authorization-request-cardcheckout.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/checkout\",\n            \"tokenHref\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoiNjd5bnJnSTR3a3FITW00SHNjaE90YnAwcVlvZ1pSZ3RFOXJjcklzVzY1ND0ifQ\",\n            \"cvcHref\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/sessions/eyJrIjoxLCJkIjoiNjQxbUswTlVFYW05NWY2R0IvUEtqWXY0QjVyY2V5VHBBU0Q1TDNuSFQrMGtEc3RIZm1NQnFtNDhKcVB1TkoySDkycWhpRHVwSHBZY3F6NEZiUGwxVHc9PSJ9\"\n        }\n    }\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Descriptions of your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateCardOnFile"]}," authorization request parameters can be found ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#descriptions-of-your-authorization-request-parameters"},"children":["here"]}," and here for your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#3ds"},"children":["3DS parameters"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["migrateCardOnFile authorization optional fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The requests below contain all the ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["mandatory and optional"]}," fields needed for a successful ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateCardOnFile"]}," authorization request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"complete-migratecardonfile-authorization-request-schema","__idx":24},"children":["Complete ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateCardOnFile"]}," authorization request schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateCardOnFile"]}," authorization request body:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Token All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/requests/authorization-request-all-token.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1000\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\",\n            \"line2\": \"order number\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\",\n            \"cvc\": \"898\"\n        },\n        \"intent\": \"instalment\"\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS1 Token All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/requests/authorization-request-all-3ds1-token-cof.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1000\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\",\n            \"line2\": \"order number\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\",\n            \"cvc\": \"898\"\n        },\n        \"intent\": \"instalment\"\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"1.0.2\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"z9UKb06xLziZMOXBEmWSVA1kwG0=\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"3DS2 Token All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/requests/authorization-request-all-3ds2-token-cof.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"1000\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"12345\",\n            \"isoId\": \"12345\",\n            \"subMerchant\": {\n                \"name\": \"John\",\n                \"merchantId\": \"12345\",\n                \"postalCode\": \"SW1 1AA\",\n                \"street\": \"Regent Street\",\n                \"city\": \"London\",\n                \"countryCode\": \"GB\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\",\n            \"line2\": \"order number\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/{}\",\n            \"cvc\": \"898\"\n        },\n        \"intent\": \"instalment\"\n    },\n    \"customer\": {\n        \"authentication\": {\n            \"version\": \"2.1.0\",\n            \"type\": \"3DS\",\n            \"eci\": \"05\",\n            \"authenticationValue\": \"MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=\",\n            \"transactionId\": \"683001f5-3805-423a-b580-638e4b2093b\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Checkout with CVC","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/requests/authorization-request-cardcheckout-all.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"transactionReference\": \"unique-transactionReference\",\n    \"mcc\": \"1000\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"paymentFacilitator\": {\n            \"pfId\": \"1111\",\n            \"isoId\": \"222\",\n            \"subMerchant\": {\n                \"city\": \"SubMCity\",\n                \"name\": \"SMName\",\n                \"state\": \"US\",\n                \"postalCode\": \"SM8989\",\n                \"merchantId\": \"62738\",\n                \"countryCode\": \"GB\",\n                \"street\": \"SMLondon\",\n                \"taxId\": \"1234567\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\",\n            \"line2\": \"order number\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/checkout\",\n            \"tokenHref\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoiNjd5bnJnSTR3a3FITW00SHNjaE90YnAwcVlvZ1pSZ3RFOXJjcklzVzY1ND0ifQ\",\n            \"cvcHref\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/sessions/eyJrIjoxLCJkIjoiNjQxbUswTlVFYW05NWY2R0IvUEtqWXY0QjVyY2V5VHBBU0Q1TDNuSFQrMGtEc3RIZm1NQnFtNDhKcVB1TkoySDkycWhpRHVwSHBZY3F6NEZiUGwxVHc9PSJ9\"\n        },\n        \"intent\": \"instalment\"\n    }\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Descriptions of your full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateCardOnFile"]}," authorization request parameters can be found ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#additional-parameter-descriptions"},"children":["here"]}," and here for your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#3ds"},"children":["3DS parameters"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"migratecardonfile-response","__idx":25},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["migrateCardOnFile"]}," response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"successful-payment-2","__idx":26},"children":["Successful payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an HTTP code ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an `\"outcome\": \"authorized\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["risk factors (only returned if issuer identifies conflict)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an issuer authorization code"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["scheme reference"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["links to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#cancel-an-authorization"},"children":["cancel"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#settle-an-authorization"},"children":["settle"]}," , ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#partially-settle-an-authorization"},"children":["partially settle"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/query-a-payment"},"children":["query"]}," your payment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an authorization link for the next payment in your repeat payment agreement"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"refused-payment-2","__idx":27},"children":["Refused payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an HTTP code ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"outcome\": \"refused\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/refusal-response"},"children":["refusal code"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," which gives additional context on the refusal"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response-2","__idx":28},"children":["Example response"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Token/3DS1 Token/3DS2 Token","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/responses/authorization-response.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"outcome\": \"authorized\",\n    \"issuer\": {\n        \"authorizationCode\": \"0\"\n    },\n    \"scheme\": {\n        \"reference\": \"1260019172\"\n    },\n    \"_links\": {\n        \"payments:cancel\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:settle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/full/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:partialSettle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/partials/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:events\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/events/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"curies\": [{\n            \"name\": \"payments\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payments/{rel}\",\n            \"templated\": true\n        }],\n        \"payments:CardOnFileAuthorize\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/CardOnFile/eyJrIjoiazNhYjYzMiJ9\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Token/3DS1 Token/3DS2 Token All","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/responses/authorization-response-all-cof.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"outcome\": \"authorized\",\n    \"riskFactors\": [{\n            \"risk\": \"not_matched\",\n            \"type\": \"cvc\"\n        },\n        {\n            \"risk\": \"not_checked\",\n            \"detail\": \"postcode\",\n            \"type\": \"avs\"\n        },\n        {\n            \"risk\": \"not_checked\",\n            \"detail\": \"address\",\n            \"type\": \"avs\"\n        }\n    ],\n    \"issuer\": {\n        \"authorizationCode\": \"0\"\n    },\n    \"scheme \": {\n        \"reference\": \"1260019172\"\n    },\n    \"_links\": {\n        \"payments:cancel\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:settle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/full/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:partialSettle\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/partials/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:events\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/events/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"curies\": [{\n            \"name\": \"payments\",\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payments/{rel}\",\n            \"templated\": true\n        }],\n        \"payments:CardOnFileAuthorize\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/CardOnFile/eyJrIjoiazNhYjYzMiJ9\"\n        }\n    }\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:settle"]}," action link to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/settle-or-cancel-an-authorization#settle-an-authorization"},"children":["settle the payment"]}," straight away. Alternatively you can cache the response and use the link to settle the payment later."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You must store and use the link returned in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:CardOnFileAuthorize"]}," action link to authorize your next payment."]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$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/card-payments/v5/settle-or-cancel-an-authorization"},"children":["Settle or cancel a payment"]}]}]},"headings":[{"value":"Take a payment","id":"take-a-payment","depth":1},{"value":"Authorize a payment","id":"authorize-a-payment","depth":2},{"value":"Authorization example request","id":"authorization-example-request","depth":3},{"value":"Descriptions of your authorization request parameters","id":"descriptions-of-your-authorization-request-parameters","depth":4},{"value":"3DS","id":"3ds","depth":3},{"value":"The descriptions of parameters from your 3DS authorization request","id":"the-descriptions-of-parameters-from-your-3ds-authorization-request","depth":4},{"value":"Optional fields in an authorization request","id":"optional-fields-in-an-authorization-request","depth":3},{"value":"Complete authorization request schema","id":"complete-authorization-request-schema","depth":4},{"value":"Additional parameter descriptions","id":"additional-parameter-descriptions","depth":4},{"value":"Authorization response","id":"authorization-response","depth":3},{"value":"Successful payment","id":"successful-payment","depth":3},{"value":"Refused payment","id":"refused-payment","depth":3},{"value":"Example response","id":"example-response","depth":4},{"value":"riskFactors","id":"riskfactors","depth":4},{"value":"issuer","id":"issuer","depth":4},{"value":"migrateRecurring authorization","id":"migraterecurring-authorization","depth":2},{"value":"migrateRecurring authorization example request","id":"migraterecurring-authorization-example-request","depth":4},{"value":"Complete migrateRecurring authorization request schema","id":"complete-migraterecurring-authorization-request-schema","depth":4},{"value":"migrateRecurring response","id":"migraterecurring-response","depth":4},{"value":"Successful payment","id":"successful-payment-1","depth":3},{"value":"Refused payment","id":"refused-payment-1","depth":3},{"value":"Example response","id":"example-response-1","depth":4},{"value":"migrateCardOnFile authorization","id":"migratecardonfile-authorization","depth":2},{"value":"migrateCardOnFile authorization example request","id":"migratecardonfile-authorization-example-request","depth":3},{"value":"Complete migrateCardOnFile authorization request schema","id":"complete-migratecardonfile-authorization-request-schema","depth":4},{"value":"migrateCardOnFile response","id":"migratecardonfile-response","depth":3},{"value":"Successful payment","id":"successful-payment-2","depth":3},{"value":"Refused payment","id":"refused-payment-2","depth":3},{"value":"Example response","id":"example-response-2","depth":4}],"frontmatter":{"seo":{"title":"Take a payment"}},"lastModified":"2026-05-13T07:59:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/card-payments/v5/authorize-a-payment","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}