Divide funds from a single payment amongst yourself and your parties/sellers.
Authentication Set your headers
Authorization: {your_credentials}
WP-Api-Version: 2025-06-25
Replace {your_credentials}
with your base64-encoded Basic Auth username and password given to your by your Implementation Manager.
DNS Whitelisting
Whitelist the following URLs:
https://try.access.worldpay.com/
https://access.worldpay.com/
Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.
https://try.access.worldpay.com/
https://access.worldpay.com/
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.
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.
Unique reference generated by you to identify a line item.
Unique reference generated by you to identify a party.
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.
https://try.access.worldpay.com/splitPayments
https://access.worldpay.com/splitPayments
Example request for creating a split payment
{ "reference": "5D262CB9-57F2-4176-AA7C-B76A79284277", "description": "optional split payment description", "fulfillment": { "auto": false, "paymentCommandId": "cmdJxsTja3Daad6dig338w2R0" }, "merchant": { "entity": "default" }, "value": { "currency": "GBP", "totalAmount": 100 }, "lineItems": [ { "itemReference": "aaa1", "partyReference": "The Baker Street Café", "amount": 90, "description": "Item description", "deductions": [ { "type": "commission", "value": { … }, "description": "Deduction description" } ] }, { "itemReference": "bbb1", "partyReference": "John Watson", "amount": 10, "description": "Item description", "deductions": [ { "type": "fee", "value": { … }, "description": "Deduction description" } ] } ] }
{ "splitPaymentId": "spl9wdyDYROy6-boa2mSFfn20", "lineItems": [ { "itemId": "itmZRsCU4vjopY6q9HH9znXQ0", "itemReference": "111BB" } ] }
A reference generated by you to identify each lifecycle event of a payment.
Description of the fulfillment
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.
https://try.access.worldpay.com/splitPayments/{splitPaymentId}/fulfillments
https://access.worldpay.com/splitPayments/{splitPaymentId}/fulfillments
{ "reference": "5D262CB9-57F2-4176-AA7C-B76A79284276", "description": "optional description of fulfillment", "paymentCommandId": "cmdJxsTja3Daad6dig338w2R0", "transactionType": "settle" }
{ "fulfillment": "accepted" }
Command reference generated by you.
Description of the fulfillment
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.
https://try.access.worldpay.com/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments
https://access.worldpay.com/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments
{ "reference": "5D262CB9-57F2-4176-AA7C-B76A79284276", "description": "optional description of fulfillment", "paymentCommandId": "cmdJxsTja3Daad6dig338w2R0", "transactionType": "settle" }
{ "fulfillment": "accepted" }