{"templateId":"markdown","versions":[{"version":"v5","label":"v5","link":"/products/card-payments/v5/take-a-sale","default":false,"active":false,"folderId":"5e391095"},{"version":"v6","label":"v6","link":"/products/card-payments/v6/take-a-sale","default":false,"active":true,"folderId":"5e391095"},{"version":"v7","label":"v7 (Latest)","link":"/products/card-payments/v7/take-a-sale","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 recurring sale","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 30 March 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-recurring-sale","__idx":0},"children":["Take a recurring sale"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use our recurring sale resource when you are initiating a payment using your customer's stored card details, and you want to instantly trigger the settlement process."," ","Read more about recurring mandates ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/articles/repeat-payments"},"children":["here"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"what-are-recurring-payments","__idx":1},"children":["What are recurring payments?"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A transaction that is triggered by a process when your customer is not actively participating at the point of authorization"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Can only be performed as a follow up from an original card on file payment when your customer was authenticated and agreed to a standing instruction"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You must declare the intent for all recurring payments, either: subscription, instalment or unscheduled"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sometimes referred to as Merchant Initiated Transaction (MIT)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisite","__idx":2},"children":["Prerequisite"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You must ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-verifications/v5/get-started"},"children":["verify"]}," your customer's account before submitting your first recurring payment for authorization."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recurring-sales","__idx":3},"children":["Recurring sales"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use our recurring sale resource to authorize and settle merchant initiated transactions where you have stored the card details."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," your recurring sale request to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:recurringSale"]}," action link received in your successful ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-verifications/v5#-cardonfile-intelligent-verification"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardOnFile"]}," intelligent"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-verifications/v5#dynamiccardonfile-verification"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dynamicCardOnFile"]}]}," verification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"recurring-sale-example-request","__idx":4},"children":["Recurring sale example request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},"  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/payments/sales/recurring/{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":"p","attributes":{},"children":["Recurring sale request body:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","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\": \"Memory265-13/08/1876\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"trading name\"\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/plain\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 12,\n                \"year\": 2035\n            }\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"intent\": \"subscription\"\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"div","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\": \"Memory265-13/08/1876\",\n    \"merchant\": {\n        \"entity\": \"default\"\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"Mind Palace Ltd\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay.com/tokens/{}\"\n        },\n        \"intent\": \"unscheduled\"\n    }\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameter-descriptions","__idx":5},"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":["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.com/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.com/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":["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"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.telephone"]}," (mandatory for Amex)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subMerchant.email"]}," (mandatory for Amex)"]}]}," This information is required for every sale 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":"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.intent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A parameter detailing the reason for this particular recurring agreement. Valid intents: ",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscription"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unscheduled"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instalment"]}]}]}]}]},{"$$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 ",{"$$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":["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":["instruction.value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that contains information about the value of the payment."]}]},{"$$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/supported-countries-currencies#iso-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, see our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/create-a-token"},"children":["Tokens API"]}," on how to create a token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutInstrument.cardExpiryDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that contains your customer's card expiry date.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Mandatory for all ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"type\": \"card/plain\""]}," requests."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutInstrument.cardNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that contains your customer's card number. Mandatory for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"type\": \"card/plain\""]}," requests."]}]},{"$$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":["paymentInstrument.cardHolderName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An object that contains your customer's card name.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," This is not a mandatory field however it is recommended that you supply this to improve authorization rates. If not sent the default is \"Not Supplied\"."]}]},{"$$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) and can only be supplied with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card/plain"]}," payment instrument. 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":["instruction.debtRepayment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["❌"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DRI is a flag which identifies a payment as being for the purpose of repaying a debt. Possible value : ",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," (only supply if true)"]}]},"For more information contact your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.worldpay.com/en-GB/merchant-support#still-need-help"},"children":["Relationship Manager"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"optional-parameters","__idx":6},"children":["Optional parameters"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example recurring sale request (all parameters)"]},{"$$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 recurring sale request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full recurring sale request body:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","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\": \"Memory265-13/08/1876\",\n    \"merchant\": {\n        \"entity\": \"default\",\n        \"mcc\": \"6432\",\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                \"state\": \"WSM\",\n                \"countryCode\": \"826\",\n                \"taxId\": \"ABC-123456789\",\n                \"email\": \"test@email.com\",\n                \"telephone\": \"+447987 654321\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"Mind Palace Ltd\",\n            \"line2\": \"Memory265-13/08/1876\"\n        },\n        \"scheme\": {\n            \"reference\": \"28379213\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"billingAddress\": {\n                \"address1\": \"221B Baker Street\",\n                \"address2\": \"Marylebone\",\n                \"address3\": \"Westminster\",\n                \"postalCode\": \"NW1 6XE\",\n                \"city\": \"London\",\n                \"state\": \"Greater London\",\n                \"countryCode\": \"GB\"\n            },\n            \"type\": \"card/plain\",\n            \"cardHolderName\": \"Sherlock Holmes\",\n            \"cardNumber\": \"4444333322221111\",\n            \"cardExpiryDate\": {\n                \"month\": 12,\n                \"year\": 2035\n            }\n        },\n        \"intent\": \"instalment\"\n    }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","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\": \"Memory265-13/08/1876\",\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                \"state\": \"WSM\",\n                \"countryCode\": \"826\",\n                \"taxId\": \"ABC-123456789\",\n                \"email\": \"test@email.com\",\n                \"telephone\": \"+447987 654321\"\n            }\n        }\n    },\n    \"instruction\": {\n        \"narrative\": {\n            \"line1\": \"Mind Palace Ltd\",\n            \"line2\": \"Memory265-13/08/1876\"\n        },\n        \"value\": {\n            \"currency\": \"GBP\",\n            \"amount\": 250\n        },\n        \"paymentInstrument\": {\n            \"type\": \"card/token\",\n            \"href\": \"https://try.access.worldpay.com/tokens/{}\"\n\n        },\n        \"intent\": \"unscheduled\"\n    }\n}\n"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recurring-sale-response","__idx":7},"children":["Recurring sale response"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Best practice"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Access Worldpay returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WP-CorrelationId"]}," in the headers of service responses. We ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["highly recommend"]}," you log this. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WP-CorrelationId"]}," is used by us to examine individual service requests."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"successful-response","__idx":8},"children":["Successful response"]},{"$$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\": \"Sent for Settlement\""]}]},{"$$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 (supported by major card schemes, but may not be returned for all schemes/regions)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["links to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v6/manage-payments#fully-refund-a-payment"},"children":["refund"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v6/manage-payments#partially-refund-a-payment"},"children":["partially refund"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v6/manage-payments#reverse-a-sale"},"children":["reverse"]},"  or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v6/query-a-payment"},"children":["query payment events"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an authorization link for the next payment in your repeat payment agreement"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"paymentinstrument","__idx":9},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"paymentInstrument\""]}," object is returned if we are able to provide information related to the underlying card used in the authorization request.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note that if the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument"]}," object is returned, there is no guarantee that each field listed below will be returned with every transaction."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of paymentInstrument. Eg:",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card/plain+masked"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card/network+masked"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card/network"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.card.brand"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The card brand. Sometimes referred to as the network or scheme. Eg: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"visa\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"mastercard\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"amex\""]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.card.number.bin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The card bin. Eg:",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["444433"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[" this may contain the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*"]}]}," character."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.card.number.last4Digits"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The last four digits of the card. Eg: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1111"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[" this may contain the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*"]}]}," character, where the card number is less than 16 digits."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.card.expiryDate.month"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The card expiry month. Eg: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["11"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.card.expiryDate.year"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The card expiry year. Eg: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2025"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.card.fundingType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["How the card is funded. Eg: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credit"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["debit"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prepaid"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deferredDebit"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["chargeCard"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.card.category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the card is classed as a consumer card or a card for commercial use. Eg: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["consumer"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commercial"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.card.countryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The alpha-2 ISO-3166 country code that the card was issued in. May return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"N/A\""]}," where the country is unknown. Eg: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GB"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.card.issuer.name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of the card issuer. Eg: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Some Issuer PLC."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrument.card.paymentAccountReference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payment account reference (PAR) is a non-financial reference that uniquely identifies the underlying cardholder account. This allows you to correlate payments made with differing instruments (e.g. \"",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card/plain\""]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"card/wallet+applepay\""]},"), where the same account funds the transaction. A PAR cannot be used to initiate a payment. Eg: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ABC123DEF456GHI789JKL123MNO45"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"refused-response","__idx":10},"children":["Refused response"]},{"$$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":"li","attributes":{},"children":["a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/refusal-response#refusal-advice-codes"},"children":["refusal advice code"]}," (only if returned by the card scheme and acquirer)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["risk factors (only returned if issuer identifies conflict)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-responses","__idx":11},"children":["Example responses"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Successful","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/sale/responses/sale-response-all.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"outcome\": \"Sent for Settlement\",\n    \"issuer\": {\n        \"authorizationCode\": \"12345A\"\n    },\n    \"scheme\": {\n        \"reference\": \"1260019172\"\n    },\n    \"paymentInstrument\": {\n        \"type\": \"card/plain+masked\",\n        \"card\": {\n            \"brand\": \"visa\",\n            \"number\": {\n                \"bin\": \"444433\",\n                \"last4Digits\": \"1111\"\n            },\n            \"expiryDate\": {\n                \"month\": 12,\n                \"year\": 2025\n            },\n            \"fundingType\": \"credit\",\n            \"category\": \"consumer\",\n            \"issuer\": {\n                \"name\": \"Some Issuer PLC\"\n            },\n            \"paymentAccountReference\": \"ABC123DEF456GHI789JKL\"\n        }\n    },\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    \"_links\": {\n        \"payments:refund\": {\n            \"href\": \"https://try.access.worldpay.com/payments/settlements/refunds/full/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:partialRefund\": {\n            \"href\": \"https://try.access.worldpay.com/payments/settlements/refunds/partials/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:reversal\": {\n            \"href\": \"https://try.access.worldpay.com/payments/sales/reversals/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:events\": {\n            \"href\": \"https://try.access.worldpay.com/payments/events/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"curies\": [{\n            \"name\": \"payments\",\n            \"href\": \"https://try.access.worldpay.com/rels/payments/{rel}\",\n            \"templated\": true\n        }],\n        \"payments:recurringSale\": {\n            \"href\": \"https://try.access.worldpay.com/payments/sales/recurring/eyJrIjoiazNhYjYzMiJ9\"\n        }\n    }\n}"},"children":[]}]},{"$$mdtype":"Tag","name":"div","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    \"refusalAdvice\": {\n        \"code\": \"01\"\n    },\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            \"risk\": \"verificationFailed\",\n            \"type\": \"riskProfile\"\n        }\n    ]\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:recurringSale"]}," action link for your next recurring sale requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[" In case of an error, you can get further information in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/worldpay-error-responses"},"children":["error reference"]},"."]}]},{"$$mdtype":"Tag","name":"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/v6/manage-payments#refund-a-payment"},"children":["Refund a payment"]}]}]},"headings":[{"value":"Take a recurring sale","id":"take-a-recurring-sale","depth":1},{"value":"What are recurring payments?","id":"what-are-recurring-payments","depth":3},{"value":"Prerequisite","id":"prerequisite","depth":2},{"value":"Recurring sales","id":"recurring-sales","depth":2},{"value":"Recurring sale example request","id":"recurring-sale-example-request","depth":3},{"value":"Parameter descriptions","id":"parameter-descriptions","depth":4},{"value":"Optional parameters","id":"optional-parameters","depth":3},{"value":"Recurring sale response","id":"recurring-sale-response","depth":2},{"value":"Successful response","id":"successful-response","depth":3},{"value":"paymentInstrument","id":"paymentinstrument","depth":4},{"value":"Refused response","id":"refused-response","depth":3},{"value":"Example responses","id":"example-responses","depth":4}],"frontmatter":{"seo":{"title":"Take a recurring sale"}},"lastModified":"2026-05-13T07:59:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/card-payments/v6/take-a-sale","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}