Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Worldpay SplitPayments API

The SplitPayments API from Worldpay — 3 operation(s) for splitpayments.

Worldpay SplitPayments API is one of 45 APIs that Worldpay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SplitPayments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 27 schemas. It is described by OpenAPI 3.0.1, at version 3.

Requests are made against 2 base URLs: https://try.access.worldpay.com, https://access.worldpay.com.

3 operations 3 paths 27 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
3
Base URL
https://access.worldpay.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Worldpay SplitPayments API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

SplitPayments 3
POST
/splitPayments
Create split payments request
splitPayments 2 params body → 201400401406415422500
POST
/splitPayments/{splitPaymentId}/fulfillments
Fully settle/refund a payment
fullCaptureFulfillments 3 params body → 201400401406415500
POST
/splitPayments/{splitPaymentId}/items/{itemId}/fulfillments
Partially settle/refund a payment
singItemCaptureFulfillments 4 params body → 201400401406415500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are SplitRequest (6 properties), ItemFulfillmentsRequest (4 properties), FulfillmentsRequest (4 properties), ValidationError (3 properties). Each schema is shown below with its type and property counts.

ValidationError
object
3 properties 3 required
SplitRequest
object
6 properties 5 required
Currency
string
The [3 letter ISO-4217 currency code](/products/reference/supported-countries-currenciesiso-currency-codes).
ErrorResponse406
object
2 properties 2 required
LineItems
array
SplitResp
object
1 property
ErrorResponse500
object
2 properties 2 required
PaymentCommandID
string
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/car…
Value
object
2 properties 2 required
ItemFulfillmentsResponse
object
1 property
FulfillmentsRequest
object
4 properties 2 required
SplitResponse
object
2 properties 2 required
ErrorResponseWithValidationErrors
object
3 properties 2 required
Deductions
array
AutoFulfillment
object
2 properties 2 required
ItemFulfillmentsRequest
object
4 properties 2 required
Amount
integer
Implied decimal. For example, 250 GBP = £2.50
ErrorResponse401
object
2 properties 2 required
SplitPaymentID
string
Unique reference generated by us to identify a split payment.
Merchant
object
1 property 1 required
LineItemsResp
array
TransactionType
string
Defines the type of payment lifecycle action.
TotalAmount
integer
Implied decimal. For example, 250 GBP = £2.50.
ErrorResponse422
object
2 properties 2 required
ErrorResponse415
object
2 properties 2 required
FulfillmentsResponse
object
1 property
ItemID
string
Unique reference generated by us to identify a line item.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worldpay-splitpayments-api-openapi.yml Raw ↑

Other APIs Worldpay publishes across the network.

Worldpay Tokens API
Worldpay Card Payouts API
Worldpay Account Payouts API
Worldpay FraudSight API
Worldpay 3DS API
Worldpay APMs API
Worldpay FX API
Worldpay Hosted Payment Pages API
Worldpay Events API
Worldpay Beneficiary Account Verifications API
Worldpay Split Payments API
Worldpay Statements API