{"templateId":"markdown","versions":[{"version":"20250625","label":"2025-06-25 (Latest)","link":"/products/split-payments/manage","default":true,"active":true,"folderId":"592be2e7"}],"sharedDataIds":{"sidebar":"sidebar-products/split-payments/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/split-payments/openapi"},"props":{"metadata":{"markdoc":{"tagList":["partial","tabs","tab","admonition","code-snippet"]},"custom_product":"Split Payments","type":"markdown"},"seo":{"title":"Manage your payment","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"font","attributes":{"color":"#FF1F3E"},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["New service"]}]}," | ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 01 July 2025"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"manage-your-payment","__idx":0},"children":["Manage your payment"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"settle-the-payment","__idx":1},"children":["Settle the payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Partially or fully settle your payment through our Card Payments API using the next action link received in your original authorization response."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Fully settle","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"settle-an-authorization","__idx":2},"children":["Settle an authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To settle all the funds from a customer, send us a settle request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can only do this if you set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"requestAutoSettlement\""]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," in your payment initial request."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardPayments:settle"]}," action link, returned in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/authorize-a-payment#response"},"children":["authorization response"]},", to settle an authorization."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"settle-request","__idx":3},"children":["Settle 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/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":"Heading","attributes":{"level":3,"id":"settle-response","__idx":4},"children":["Settle response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the response you get a 202 HTTP code which confirms we have received your request. The request has not processed at this stage."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/products/card-payments/@v7/code/manage-payments/settlement-response.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"paymentId\": \"pay7TLP6nGrpumEKxy7NiuOx0\",\n  \"commandId\": \"cmdp9D1t-ENYQxVnJkh0YPRC0\",\n  \"_links\": {\n    \"cardPayments:refund\": {\n      \"href\": \"/payments/settlements/refunds/full/:linkData\"\n    },\n    \"cardPayments:partialRefund\": {\n      \"href\": \"/payments/settlements/refunds/partials/:linkData\"\n    },\n    \"cardPayments:reverse\": {\n      \"href\": \"/payments/authorizations/reversals/:linkData\"\n    },\n    \"cardPayments:events\": {\n      \"href\": \"/payments/events/:linkData\"\n    },\n    \"curies\": [\n      {\n        \"name\": \"payments\",\n        \"href\": \"/rels/payments/{rel}\",\n        \"templated\": true\n      }\n    ]\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Partial settle","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"partially-settle-an-authorization","__idx":5},"children":["Partially settle an authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To settle a portion of the funds of a payment, send us a request to partially settle an authorization."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can only do this if you set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"requestAutoSettlement\""]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," in your initial request."]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardPayments:partialSettle"]}," action link, returned in your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/authorize-a-payment#response"},"children":["authorization response"]},", to partially settle an authorization. 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 the original payment."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"partial-settle-request","__idx":6},"children":["Partial settle 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/settlements/partials/eyJrIjoiazNhYjYzMiJ9"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request","__idx":7},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"sequence\": {\n    \"number\": 1,\n    \"total\": 2\n  },\n  \"value\": {\n    \"amount\": 10,\n    \"currency\": \"GBP\"\n  },\n  \"reference\": \"partial-settle-reference\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"partial-settle-response","__idx":8},"children":["Partial settle response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the response you get a 202 HTTP code which confirms we have received your request. The request has not processed at this stage."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/products/card-payments/@v7/code/manage-payments/partial-settlement-response.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"paymentId\": \"payymIRjUAvh-rWc-7phWocp0\",\n  \"commandId\": \"cmdpsIok1vBZ_CDqWplJPl2_0\",\n  \"_links\": {\n    \"cardPayments:refund\": {\n      \"href\": \"/payments/settlements/refunds/full/:linkData\"\n    },\n    \"cardPayments:partialRefund\": {\n      \"href\": \"/payments/settlements/refunds/partials/:linkData\"\n    },\n    \"cardPayments:partialSettle\": {\n      \"href\": \"/payments/settlements/partials/:linkData\"\n    },\n    \"cardPayments:reverse\": {\n      \"href\": \"/payments/authorizations/reversals/:linkData\"\n    },\n    \"cardPayments:cancel\": {\n      \"href\": \"/payments/authorizations/cancellations/:linkData\"\n    },\n    \"cardPayments:events\": {\n      \"href\": \"/payments/events/:linkData\"\n    },\n    \"curies\": [\n      {\n        \"name\": \"payments\",\n        \"href\": \"/rels/payments/{rel}\",\n        \"templated\": true\n      }\n    ]\n  }\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"confirm-your-settlement","__idx":9},"children":["Confirm your settlement"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To complete your settlement you ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["must"]}," confirm it through our Split Payments endpoint. This allows you to independently settle ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lineItems"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request","__idx":10},"children":["Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fulfill all or some of the order items of the purchase."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Fulfill whole purchase","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical use case:"]}," The original purchase amount is £30 made up of:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["item 1: £10 Socks from retailer 1"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["item 2: £20 Sandals from retailer 2"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All items are ready to be shipped. You fulfill the whole purchase."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To initiate  ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["full settlement"]}," of the purchase, send us a settle request for the whole basket."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/splitPayments/{splitPaymentId}/fulfillments"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-1","__idx":11},"children":["Example request:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"reference\": \"5D262CB9-57F2-4176-AA7C-B76A79284276\",\n  \"description\": \"optional description of fulfillment\",\n  \"paymentCommandId\": \"cmdJxsTja3Daad6dig338w2R0\",\n  \"transactionType\": \"settle\"\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Fulfill partial purchase","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical use case:"]}," The original purchase amount is £100, made up of:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["item 1: £50 books from retailer 1 and"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["item 2: £50 jacket from retailer 2"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only item 1 is ready to be shipped today. You partially fulfill the order and might fulfill item 2 later on."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To initiate a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["partial settlement"]}," from the purchase, send us a settle request for a single item:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-2","__idx":12},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"reference\": \"5D262CB9-57F2-4176-AA7C-B76A79284276\",\n  \"description\": \"optional description of fulfillment\",\n  \"paymentCommandId\": \"cmdJxsTja3Daad6dig338w2R0\",\n  \"transactionType\": \"settle\"\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":13},"children":["Response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example","__idx":14},"children":["Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["•\t201 Merchant Pay-in accepted"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"fulfillments\": \"Accepted\"\n}\n\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"refund-a-payment","__idx":15},"children":["Refund a payment"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"refund-the-payment","__idx":16},"children":["Refund the payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Partially or fully refund your payment through our Card Payments API using the next action link received in your authorization response."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Fully refund","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"refund-an-authorization","__idx":17},"children":["Refund an authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To refund all the funds to a customer, send us a refund request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardPayments:refund"]}," action link, returned in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/authorize-a-payment#response"},"children":["authorization response"]},", to refund an authorization."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"refund-request","__idx":18},"children":["Refund 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/settlements/refunds/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":["The payment event changes to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentForRefund"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"refund-response","__idx":19},"children":["Refund response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the response you get a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]}," HTTP code which confirms we have received your request. The request has not processed at this stage."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/products/card-payments/@v7/code/manage-payments/full-refund-response.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"paymentId\": \"payqRdrJboocTc1dCVdAu4Vd0\",\n  \"commandId\": \"cmddn9j_SEC7N4_ynTDRBWc-0\",\n  \"_links\": {\n    \"cardPayments:events\": {\n      \"href\": \"/payments/events/:linkData\"\n    },\n    \"curies\": [\n      {\n        \"name\": \"payments\",\n        \"href\": \"/rels/payments/{rel}\",\n        \"templated\": true\n      }\n    ]\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Partial refund","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"partially-refund-an-authorization","__idx":20},"children":["Partially refund an authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To refund a portion of the funds of a payment, send us a request to partially refund an authorization."]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardPayments:partialRefund"]}," action link, returned in your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/authorize-a-payment#response"},"children":["authorization response"]},", to partially refund an authorization. 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 the original payment."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"partial-refund-request","__idx":21},"children":["Partial refund 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/settlements/refunds/partials/eyJrIjoiazNhYjYzMiJ9"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-3","__idx":22},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"value\": {\n    \"amount\": 10,\n    \"currency\": \"GBP\"\n  },\n  \"reference\": \"partial-refund-reference\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"partial-refund-response","__idx":23},"children":["Partial refund response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the response you get a 202 HTTP code which confirms we have received your request. The request has not processed at this stage."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/products/card-payments/@v7/code/manage-payments/partial-refund-response.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"paymentId\": \"payleHRjF9Ca-mxSJNcJ6V3K0\",\n  \"commandId\": \"cmdzEVdGDvH72FI1i2ypIf3B0\",\n  \"_links\": {\n    \"cardPayments:events\": {\n      \"href\": \"/payments/events/:linkData\"\n    },\n    \"curies\": [\n      {\n        \"name\": \"payments\",\n        \"href\": \"/rels/payments/{rel}\",\n        \"templated\": true\n      }\n    ]\n  }\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"confirm-your-refund","__idx":24},"children":["Confirm your refund"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You must confirm the refund through our Split Payments API."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Full refund confirmation","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To confirm a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["full refund"]}," from a purchase, send us a request for the whole basket."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/splitPayments/{splitPaymentId}/fulfillments"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-4","__idx":25},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"reference\": \"5D262CB9-57F2-4176-AA7C-B76A79284276\",\n  \"description\": \"optional description of fulfillment\",\n  \"paymentCommandId\": \"cmdJxsTja3Daad6dig338w2R0\",\n  \"transactionType\": \"refund\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response","__idx":26},"children":["Example response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["•\t201 Merchant Pay-in  accepted"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"fulfillments\": \"Accepted\"\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Partial refund confirmation","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To confirm a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["partial refund"]}," from a purchase, you must send a request for a single item."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-5","__idx":27},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"reference\": \"5D262CB9-57F2-4176-AA7C-B76A79284276\",\n  \"description\": \"optional description of fulfillment\",\n  \"paymentCommandId\": \"cmdJxsTja3Daad6dig338w2R0\",\n  \"transactionType\": \"refund\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-1","__idx":28},"children":["Example response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["•\t201 Merchant Pay-in  accepted"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"fulfillments\": \"Accepted\"\n}\n"},"children":[]}]}]}]},"headings":[{"value":"Manage your payment","id":"manage-your-payment","depth":1},{"value":"Settle the payment","id":"settle-the-payment","depth":2},{"value":"Settle an authorization","id":"settle-an-authorization","depth":2},{"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":2},{"value":"Partial settle request","id":"partial-settle-request","depth":3},{"value":"Example request","id":"example-request","depth":4},{"value":"Partial settle response","id":"partial-settle-response","depth":3},{"value":"Confirm your settlement","id":"confirm-your-settlement","depth":2},{"value":"Request","id":"request","depth":3},{"value":"Example request:","id":"example-request-1","depth":4},{"value":"Example request","id":"example-request-2","depth":4},{"value":"Response","id":"response","depth":3},{"value":"Example","id":"example","depth":4},{"value":"Refund a payment","id":"refund-a-payment","depth":2},{"value":"Refund the payment","id":"refund-the-payment","depth":2},{"value":"Refund an authorization","id":"refund-an-authorization","depth":2},{"value":"Refund request","id":"refund-request","depth":3},{"value":"Refund response","id":"refund-response","depth":3},{"value":"Partially refund an authorization","id":"partially-refund-an-authorization","depth":2},{"value":"Partial refund request","id":"partial-refund-request","depth":3},{"value":"Example request","id":"example-request-3","depth":4},{"value":"Partial refund response","id":"partial-refund-response","depth":3},{"value":"Confirm your refund","id":"confirm-your-refund","depth":2},{"value":"Example request","id":"example-request-4","depth":3},{"value":"Example response","id":"example-response","depth":3},{"value":"Example request","id":"example-request-5","depth":3},{"value":"Example response","id":"example-response-1","depth":3}],"frontmatter":{"breadcrumbs":{"hide":true},"seo":{"title":"Manage your payment"}},"lastModified":"2026-06-16T14:34:05.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/split-payments/manage","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}