{"templateId":"markdown","versions":[{"version":"v5","label":"v5","link":"/products/card-payments/v5/authorise-a-cardonfile-payment","default":false,"active":true,"folderId":"5e391095"},{"version":"v6","label":"v6","link":"/products/card-payments/v6/authorise-a-cardonfile-payment","default":false,"active":false,"folderId":"5e391095"},{"version":"v7","label":"v7 (Latest)","link":"/products/card-payments/v7/authorise-a-cardonfile-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 card on file 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-card-on-file-payment","__idx":0},"children":["Take a card on file payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use our CardOnFile resource to authorize a CardOnFile payment."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["What are Card on File payments?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Card on File payments"]}," are made by the cardholder using the payment instrument details that have already been stored, such as one-click or in-app purchases. They differ from recurring payments as they don't follow a schedule and are not initiated by the merchant. A Card on File payment is an example of a Cardholder Initiated Transaction (CIT)."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"cardonfile-request","__idx":1},"children":["CardOnFile request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," your CardOnFile request to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:cardonFileAuthorize"]}," action link received in your successful ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-verifications/v5/verifications#onetime-intelligent-verification"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["oneTime"]}," intelligent"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-verifications/v5/verifications#dynamic-cardonfile-verification"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dynamicOneTime"]}]}," verification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"cardonfile-example-request","__idx":2},"children":["CardOnFile 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/cardonFile/{resource}"]}]},{"$$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":"Heading","attributes":{"level":4,"id":"cardonfile-request-body","__idx":3},"children":["CardOnFile 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/cof/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/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":"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":"Heading","attributes":{"level":4,"id":"parameter-descriptions","__idx":4},"children":["Parameter descriptions"]},{"$$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 the 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 character max. If character is not supported it is replaced with a space.).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"See [narrative ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line1"]},"](/products/reference/formatting.md#narrative-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 3 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 ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/create-a-token"},"children":["create a token"]},". To use \"checkout with CVC\" 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":"Heading","attributes":{"level":3,"id":"optional-parameters","__idx":5},"children":["Optional parameters"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Optional parameters and descriptions"]},{"$$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 card on file request ",{"$$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":"p","attributes":{},"children":["The requests below contain all the ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["mandatory and optional"]}," fields needed for a successful card on file request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full card on file request body"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Card complete request","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cof/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        \"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        \"intent\": \"instalment\"\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Token complete request","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":"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":"Heading","attributes":{"level":2,"id":"card-on-file-response","__idx":6},"children":["Card on file response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"successful-payment","__idx":7},"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#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","__idx":8},"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","__idx":9},"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/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":"Card/Token complete response","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":"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":["You must always store and use the link returned in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:CardOnFileAuthorize"]}," action link to authorize your next CardOnFile payment."]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"\n---\n",{"$$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/refund-a-payment"},"children":["Refund a payment"]}]}]},"headings":[{"value":"Take a card on file payment","id":"take-a-card-on-file-payment","depth":1},{"value":"CardOnFile request","id":"cardonfile-request","depth":2},{"value":"CardOnFile example request","id":"cardonfile-example-request","depth":3},{"value":"CardOnFile request body:","id":"cardonfile-request-body","depth":4},{"value":"Parameter descriptions","id":"parameter-descriptions","depth":4},{"value":"Optional parameters","id":"optional-parameters","depth":3},{"value":"Card on file response","id":"card-on-file-response","depth":2},{"value":"Successful payment","id":"successful-payment","depth":3},{"value":"Refused payment","id":"refused-payment","depth":3},{"value":"Example response","id":"example-response","depth":4}],"frontmatter":{"seo":{"title":"Take a card on file payment"}},"lastModified":"2026-05-13T07:59:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/card-payments/v5/authorise-a-cardonfile-payment","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}