Divide funds from a single payment amongst yourself and your parties/sellers.
Authentication Set your headers
Authorization: {your_credentials}
WP-Api-Version: 2024-10-10
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/
Reference for the purchase generated by you.
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.
The text that appears on your customer's statement.
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.
Unique reference generated by you to identify a purchase item.
Unique reference generated by you to identify a party.
https://try.access.worldpay.com/splitPayments/purchases
https://access.worldpay.com/splitPayments/purchases
For every purchase you can define how you want to split the funds between the number of entities that belong to yourself and the beneficiaries on your platform
{ "purchaseReference": "5D262CB9-57F2-4176-AA7C-B76A79284277", "fulfillment": { "auto": false, "commandId": "cmdJxsTja3Daad6dig338w2R0", "commandReference": "5D262CB9-57F2-4176-AA7C-B76A79284276" }, "merchant": { "entity": "default" }, "narrative": { "line1": "Socks", "line2": "Sandals" }, "value": { "currency": "GBP", "totalAmount": 50 }, "items": [ { "itemReference": "aaa1", "partyReference": "Sherlock Holmes", "amount": 30, "narrative": { "line1": "Socks" }, "commission": { "narrative": { "line1": "Socks" }, "amount": 3 }, "fee": { "narrative": { "line1": "Socks" }, "amount": 2 } }, { "itemReference": "bbb1", "partyReference": "John Watson", "amount": 20, "narrative": { "line1": "Sandals" }, "commission": { "narrative": { "line1": "Sandals" }, "amount": 3 }, "fee": { "narrative": { "line1": "Sandals" }, "amount": 2 } } ] }
{ "purchaseId": "purd1dcd2dee333cae1bfdea0", "purchase": { "items": [ { "itemId": "itmd1dcd2dee333cae1bfded0", "itemReference": "aaa1" } ] } }
Timestamp of this request per RFC3339 section 5.6
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.
A reference generated by you to identify each lifecycle event of a payment.
The text that appears on your customer's statement.
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/purchases/{purchaseId}/fulfillments
https://access.worldpay.com/splitPayments/purchases/{purchaseId}/fulfillments
Register a command ID for a full capture
{ "commandId": "cmdyv_5QNY5uuwsm-6HlE1f80", "commandReference": "5D262CB9-57F2-4176-AA7C-B76A79284276", "transactionType": "Settle", "narrative": { "line1": "Socks", "line2": "Sandals" } }
{ "fulfillments": "Accepted" }
Timestamp of this request per RFC3339 section 5.6
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.
Command reference generated by you.
The text that appears on your customer's statement.
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/purchases/{purchaseId}/items/{itemId}/fulfillments
https://access.worldpay.com/splitPayments/purchases/{purchaseId}/items/{itemId}/fulfillments
Register a command ID for a partial capture/single item
{ "commandId": "cmdWYl_hJt7N2Yw7d-Lpp2oi0", "commandReference": "5D262CB9-57F2-4176-AA7C-B76A79284276", "transactionType": "Settle", "narrative": { "line1": "Socks" } }
{ "fulfillments": "Accepted" }