{"templateId":"markdown","versions":[{"version":"20250625","label":"2025-06-25 (Latest)","link":"/products/split-payments/split-a-payment","default":true,"active":true,"folderId":"592be2e7"}],"sharedDataIds":{"sidebar":"sidebar-products/split-payments/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/split-payments/openapi","oas-products/split-payments/@20250625/openapi.yaml":"oas-products/split-payments/@20250625/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition","openapi-code-sample","json-schema"]},"custom_product":"Split Payments","type":"markdown"},"seo":{"title":"Split a payment","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.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":["openapi"],"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":"split-a-payment","__idx":0},"children":["Split a payment"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-use-case","__idx":1},"children":["Example use case"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This example outlines a split payment journey within a food delivery marketplace platform. Ensuring a seamless experience for customer, restaurant and driver."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scenario:"]}," A customer orders a food delivery from a local restaurant, the Baker Street Café, to their home."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Order placement:"]}," Customer makes food order for £100."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Order acceptance and delivery:"]}," Restaurant accepts order and sends food via delivery driver."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payment distribution:"]}," The food delivery marketplace splits the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"totalAmount\": 10000"]}," as follows:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["restaurant:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"amount\": 9000"]},", with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commission"]}," of 1% being taken by the food delivery marketplace. The marketplace therefore receives £0.10 in their virtual Worldpay bank account, leaving £89.10 to be paid out to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partyReference: \"The Baker Street Café\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["delivery driver:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"amount\": 1000"]},", with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fee"]}," of £2 being taken by the food delivery marketplace, which they will receive in their virtual Worldpay bank account. Leaving £8 to be paid out to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"partyReference\": John Watson\""]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request","__idx":2},"children":["Request"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Best Practice"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only split a payment once you have submitted the final amount to be authorized."]}]},{"$$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"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-examples","__idx":3},"children":["Request examples"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/split-payments/@20250625/openapi.yaml","operationId":"splitPayments","exampleKey":"SplitPayment","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-schema","__idx":4},"children":["Request schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"openapi.yaml#/components/schemas/SplitRequest"},"options":{"schemaExpansionLevel":0},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/SplitRequest"},"PaymentCommandID":{"type":"string","description":"A unique ID generated by us for each lifecycle event on a payment. You have received this in the [response of your payment authorization request](/products/card-payments/openapi/other/authorize#other/authorize/t=response&c=201&path=&d=0/commandid) in our Card Payments API.","minLength":25,"maxLength":25,"pattern":"^cmd[A-Za-z0-9_-]{21}0$"},"AutoFulfillment":{"required":["auto","paymentCommandId"],"type":"object","properties":{"auto":{"type":"boolean","description":"Set to 'true' for auto fulfillment, otherwise to 'false'"},"paymentCommandId":{"$ref":"#/components/schemas/PaymentCommandID"}}},"Merchant":{"required":["entity"],"type":"object","properties":{"entity":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","type":"string","description":"Used to route the request in Access Worldpay, created as part of on-boarding.","example":"default"}}},"Currency":{"type":"string","description":"The [3 letter ISO-4217 currency code](/products/reference/supported-countries-currencies#iso-currency-codes).","example":"GBP","pattern":"^[A-Z]{3}$"},"TotalAmount":{"type":"integer","example":250,"minimum":1,"description":"Must be positive integer greater than 0. Implied decimal. For example, 250 GBP = £2.50."},"Value":{"required":["currency","totalAmount"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"totalAmount":{"$ref":"#/components/schemas/TotalAmount"}}},"Amount":{"type":"integer","example":250,"minimum":1,"description":"Must be positive integer greater than 0. Implied decimal. For example, 250 GBP = £2.50"},"Deductions":{"type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"Type of deduction.","enum":["commission","fee"],"example":"commission"},"value":{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","description":"Type of value.","enum":["percentage","flat"],"example":"percentage"},"amount":{"type":"integer","example":75,"description":"percentage or flat amount of the deduction. For example, 75 = 0.75% or £0.75"}}},"description":{"pattern":"^[a-zA-Z0-9 ,./-]*$","type":"string","maxLength":50,"description":"Used to identify a split payment of an order to help with reconciliation purposes. When used, the values appear in the Payouts Portal.","example":"Deduction description"}}}},"LineItems":{"type":"array","items":{"required":["itemReference","partyReference","amount"],"type":"object","properties":{"itemReference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","type":"string","description":"Unique reference generated by you to identify a line item."},"partyReference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","type":"string","description":"Unique reference generated by you to identify a party."},"amount":{"$ref":"#/components/schemas/Amount"},"description":{"maxLength":50,"pattern":"^[a-zA-Z0-9 ,./-]*$","type":"string","description":"Used to identify a split payment of an order to help with reconciliation purposes. When used, the values appear in the Payouts Portal."},"deductions":{"$ref":"#/components/schemas/Deductions"}}}},"SplitRequest":{"required":["reference","fulfillment","merchant","value","lineItems"],"properties":{"reference":{"maxLength":64,"minLength":1,"type":"string","pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","description":"A reference generated by you to identify the split payments."},"description":{"maxLength":50,"pattern":"^[a-zA-Z0-9 ,./-]*$","type":"string","description":"Used to identify a split payment of an order to help with reconciliation purposes. When used, the values appear in the Payouts Portal."},"fulfillment":{"$ref":"#/components/schemas/AutoFulfillment"},"merchant":{"$ref":"#/components/schemas/Merchant"},"value":{"$ref":"#/components/schemas/Value"},"lineItems":{"$ref":"#/components/schemas/LineItems"}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"deductions","__idx":5},"children":["Deductions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optional commissions and fees are deducted per ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lineItem"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#request-examples"},"children":["above example"]}," where ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"itemReference\"=\"aaa1\""]}," and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"amount\": 90"]},", a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commission"]}," of 1% is taken against the £90. Leaving £89.10 to be paid out to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"partyReference\": \"The Baker Street Café\""]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There is also a second deduction taken against ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"itemReference\"=\"bbb2\""]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"amount\": 10"]},". In the request a flat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fee"]}," of £2 is taken. The remainder of £8 will be paid out to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"partyReference\": \"John Watson\""]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-extract","__idx":6},"children":["Example extract"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"\"deductions\": [\n        {\n          \"type\": \"commission\",\n          \"value\": {\n            \"type\": \"percentage\",\n            \"amount\": 1\n          },\n          \"description\": \"Deduction description\"\n        }\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["View our full request and response schema in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/split-payments/openapi"},"children":["API reference"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response","__idx":7},"children":["Response"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-response","__idx":8},"children":["Example response"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/split-payments/@20250625/openapi.yaml","operationId":"splitPayments","exampleKey":"examples/responses/split-201.yaml","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-schema","__idx":9},"children":["Response schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"openapi.yaml#/components/schemas/SplitResponse"},"options":{"schemaExpansionLevel":0},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/SplitResponse"},"SplitPaymentID":{"type":"string","description":"Unique reference generated by us to identify a split payment.","minLength":25,"maxLength":25,"pattern":"^spl[A-Za-z0-9_-]{21}0$"},"ItemID":{"type":"string","description":"Unique reference generated by us to identify a line item.","minLength":25,"maxLength":25,"pattern":"^itm[A-Za-z0-9_-]{21}0$"},"LineItemsResp":{"type":"array","items":{"required":["itemId","itemReference"],"type":"object","properties":{"itemId":{"$ref":"#/components/schemas/ItemID"},"itemReference":{"maxLength":64,"minLength":1,"pattern":"^[-A-Za-z0-9_!@#$%()*=.:;?\\\\[\\\\]{}~`/+]+$","type":"string","description":"Unique reference generated by you to identify a line item."}}}},"SplitResp":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/LineItemsResp"}}},"SplitResponse":{"type":"object","required":["splitPaymentId","lineItems"],"properties":{"splitPaymentId":{"$ref":"#/components/schemas/SplitPaymentID"},"lineItems":{"$ref":"#/components/schemas/SplitResp"}}}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"errors","__idx":10},"children":["Errors"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Check out our API reference for the full ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/split-payments/openapi/other/splitpayments#other/splitpayments/response&c=201"},"children":["error code schema"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fulfillment.auto"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," you ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["must"]}," now settle your payment."]}]},{"$$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/split-payments/manage"},"children":["Settle your purchase"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/split-payments/manage#refund-a-payment"},"children":["Refund your purchase"]}]}]},"headings":[{"value":"Split a payment","id":"split-a-payment","depth":1},{"value":"Example use case","id":"example-use-case","depth":3},{"value":"Request","id":"request","depth":2},{"value":"Request examples","id":"request-examples","depth":4},{"value":"Request schema","id":"request-schema","depth":4},{"value":"Deductions","id":"deductions","depth":3},{"value":"Example extract","id":"example-extract","depth":4},{"value":"Response","id":"response","depth":2},{"value":"Example response","id":"example-response","depth":4},{"value":"Response schema","id":"response-schema","depth":4},{"value":"Errors","id":"errors","depth":4}],"frontmatter":{"breadcrumbs":{"hide":true},"seo":{"title":"Split a payment"}},"lastModified":"2025-11-26T14:54:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/split-payments/split-a-payment","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}