{"templateId":"markdown","versions":[{"version":"v5","label":"v5","link":"/products/card-payments/v5/settle-or-cancel-an-authorization","default":false,"active":true,"folderId":"5e391095"},{"version":"v6","label":"v6","link":"/products/card-payments/v6/settle-or-cancel-an-authorization","default":false,"active":false,"folderId":"5e391095"},{"version":"v7","label":"v7 (Latest)","link":"/products/card-payments/v7/settle-or-cancel-an-authorization","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","code-snippet"]},"custom_product":"Card Payments","type":"markdown"},"seo":{"title":"Settle or cancel an authorization","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":"settle-or-cancel-an-authorization","__idx":0},"children":["Settle or cancel an authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After you receive a successful authorization you can:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#settle-an-authorization"},"children":["Settle"]}," the authorization to receive all the funds from your customer and complete the payment."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#partially-settle-an-authorization"},"children":["Partially settle"]}," the authorization to receive a portion of the funds from your customer and partially complete the payment."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#cancel-an-authorization"},"children":["Cancel"]}," the authorization to remove the fund reservation from your customer account."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"settle-an-authorization","__idx":1},"children":["Settle an authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To receive all the funds from the customer send us a settle request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:settle"]}," action link received in any of the authorization responses to settle an authorization."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"settle-request","__idx":2},"children":["Settle request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/full/eyJrIjoiazNhYjYzMiJ9"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No request body is needed for this request."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you make your settle request, the payment event changes to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentForSettlement"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful settle request does not mean that the payment will be settled, this is at the discretion of the card acquirer."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"settle-response","__idx":3},"children":["Settle response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In your response you get links to, ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/refund-a-payment"},"children":["refund, partial refund"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/query-a-payment"},"children":["query"]}," an authorization."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/settlement-response.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"_links\": {\n        \"payments:refund\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/refunds/full/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:partialRefund\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/refunds/partials/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:events\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/events/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"curies\": [\n            {\n                \"name\": \"payments\",\n                \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payments/{rel}\",\n                \"templated\": true\n            }\n        ]\n    }\n}"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"partially-settle-an-authorization","__idx":4},"children":["Partially settle an authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To receive a portion of the funds from the customer send us a partial settle request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST your partial settlement request to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:partialRefund"]}," action link you received in your authorization response. Specify the amount and the  required settlement currency in the body."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We do not validate that the currency and amount is the same as that of the original payment."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"partially-settle-request","__idx":5},"children":["Partially settle request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/partials/eyJrIjoiazNhYjYzMiJ9"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/partial-settlement.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"value\": {\n        \"amount\": 125,\n        \"currency\": \"GBP\"\n    },\n    \"reference\": \"partial-settle-reference\"\n}"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Descriptions of your partial settlement 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":["reference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["unique"]}," reference generated by you used to identify the partial settlement. For more information and best practice see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/formatting#transaction-reference-format"},"children":["transaction reference format"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"partially-settle-response","__idx":6},"children":["Partially settle response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the response, you get links to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/refund-a-payment"},"children":["refund, partial refund"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/query-a-payment"},"children":["query"]}," the payment."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/partial-settlement-response.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"_links\": {\n        \"payments:refund\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/refunds/full/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:partialRefund\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/refunds/partials/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"payments:events\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/events/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"curies\": [\n            {\n                \"name\": \"payments\",\n                \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payments/{rel}\",\n                \"templated\": true\n            }\n        ]\n    }\n}"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"cancel-an-authorization","__idx":7},"children":["Cancel an authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you don’t want to proceed with payment send us a cancel request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments:cancel"]}," action link returned in any of your authorization responses to cancel the authorization."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can only cancel an authorization which has been ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorized"]},", if an authorization has been settled then you need to create a refund."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request","__idx":8},"children":["Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["POST ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiJ9"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No request body is needed for this request."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":9},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the response you get links allowing you to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/query-a-payment"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]}]}," the payment."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/cancel-response.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"_links\": {\n        \"payments:events\": {\n            \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/events/eyJrIjoiazNhYjYzMiJ9\"\n        },\n        \"curies\": [\n            {\n                \"name\": \"payments\",\n                \"href\": \"https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payments/{rel}\",\n                \"templated\": true\n            }\n        ]\n    }\n}"},"children":[]},{"$$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/refund-a-payment"},"children":["Refund a payment"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/v5/query-a-payment"},"children":["Query a payment"]}]}]},"headings":[{"value":"Settle or cancel an authorization","id":"settle-or-cancel-an-authorization","depth":1},{"value":"Settle an authorization","id":"settle-an-authorization","depth":1},{"value":"Settle request","id":"settle-request","depth":3},{"value":"Settle response","id":"settle-response","depth":3},{"value":"Partially settle an authorization","id":"partially-settle-an-authorization","depth":1},{"value":"Partially settle request","id":"partially-settle-request","depth":3},{"value":"Partially settle response","id":"partially-settle-response","depth":3},{"value":"Cancel an authorization","id":"cancel-an-authorization","depth":1},{"value":"Request","id":"request","depth":3},{"value":"Response","id":"response","depth":3}],"frontmatter":{"seo":{"title":"Settle or cancel an authorization"}},"lastModified":"2025-11-26T14:54:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/card-payments/v5/settle-or-cancel-an-authorization","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}