New service | Last updated: 01 July 2025
Split a Payment
Example Use Case
This example outlines a split payment journey within a food delivery marketplace platform. Ensuring a seamless experience for customer, restaurant and driver.
Scenario: A customer orders a food delivery from a local restaurant, the Baker Street Café, to their home.
- Order Placement: Customer makes food order for £100.
- Order Acceptance and Delivery: Restaurant accepts order and sends food via delivery driver.
- Payment Distribution: The food delivery marketplace splits the
"totalAmount": 10000
as follows:- Restaurant:
"amount": 9000
, with acommission
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 topartyReference: "The Baker Street Café"
- Delivery Driver:
"amount": 1000
, with afee
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"partyReference": John Watson"
- Restaurant:
Request
Only split a payment once you have submitted the final amount to be authorized.
POST
https://try.access.worldpay.com/splitPayments
Request examples
{ "splitPaymentId": "spl9wdyDYROy6-boa2mSFfn20", "lineItems": [ { "itemId": "itmZRsCU4vjopY6q9HH9znXQ0", "itemReference": "aaa1" }, { "itemId": "itmO9IHhLjjamTh9oHcR1wH-0", "itemReference": "bbb1" } ] }
Request schema
Reference for the split payments generated by you.
Text to appear on the customer's billing statement. Sometimes referred to as a billing descriptor. If this isn't set, the value from the merchant profile is used.
Set to 'true' for auto fulfillment, otherwise to 'false'
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 in our Card Payments API.
Used to route the request in Access Worldpay, created as part of on-boarding.
Implied decimal. For example, 250 GBP = £2.50.
Unique reference generated by you to identify a line item.
Unique reference generated by you to identify a party.
Implied decimal. For example, 250 GBP = £2.50
Text to appear on the customer's billing statement. Sometimes referred to as a billing descriptor. If this isn't set, the value from the merchant profile is used.
Deductions
Optional commissions and fees are deducted per lineItem
.
In the above example where "itemReference"="aaa1"
and the "amount": 90
, a commission
of 1% is taken against the £90. Leaving £89.10 to be paid out to "partyReference": "The Baker Street Café"
.
There is also a second deduction taken against "itemReference"="bbb2"
with "amount": 10
. In the request a flat fee
if £2 is taken. The remainder of £8 will be paid out to "partyReference": "John Watson"
Example extract
"deductions": [
{
"type": "commission",
"value": {
"type": "percentage",
"amount": 1
},
"description": "Deduction description"
}
View our full request and response schema in our API reference.
Response
Example response
{ "splitPaymentId": "spl9wdyDYROy6-boa2mSFfn20", "lineItems": [ { "itemId": "itmZRsCU4vjopY6q9HH9znXQ0", "itemReference": "aaa1" }, { "itemId": "itmO9IHhLjjamTh9oHcR1wH-0", "itemReference": "bbb1" } ] }
Response schema
Unique reference generated by us to identify a split payment.
Errors
Check out our API reference for the full error code schema.
If you have set fulfillment.auto
to false
you must now settle your payment.
Next Steps