Create split payments request

Request

Create a request allowing you to split your payment.

Security

BasicAuth

Content-Typestringrequired

The Content-Type.

Example:application/json

WP-Api-Versionstringrequired

The API version.

Example:2025-06-25

Bodyapplication/json

referencestring, [ 1 .. 64 ] characters^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]+$required

A reference generated by you to identify the split payments.

descriptionstring, <= 50 characters^[a-zA-Z0-9 ,./-]*$

Used to identify a split payment of an order to help with reconciliation purposes. When used, the values appear in the Payouts Portal.

fulfillmentobjectrequired

merchantobjectrequired

valueobjectrequired

lineItemsArray of objectsrequired

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": 10000
  },
  "lineItems": [
    {
      "itemReference": "aaa1",
      "partyReference": "The Baker Street Café",
      "amount": 9000,
      "description": "Item description",
      "deductions": [
        {
          "type": "commission",
          "value": {
            "type": "percentage",
            "amount": 1
          },
          "description": "Deduction description"
        }
      ]
    },
    {
      "itemReference": "bbb1",
      "partyReference": "John Watson",
      "amount": 1000,
      "description": "Item description",
      "deductions": [
        {
          "type": "fee",
          "value": {
            "type": "flat",
            "amount": 200
          },
          "description": "Deduction description"
        }
      ]
    }
  ]
}

Responses

Merchant Pay-in accepted

Headers

WP-CorrelationIdstring, (uuid)

Example:"c85762a8-93af-47e7-beae-345d3dddbe94"

Bodyapplication/json

splitPaymentIdstring, = 25 characters^spl[A-Za-z0-9_-]{21}0$required

Unique reference generated by us to identify a split payment.

lineItemsobjectrequired

Response

{
  "splitPaymentId": "spl9wdyDYROy6-boa2mSFfn20",
  "lineItems": [
    {
      "itemId": "itmZRsCU4vjopY6q9HH9znXQ0",
      "itemReference": "aaa1"
    },
    {
      "itemId": "itmO9IHhLjjamTh9oHcR1wH-0",
      "itemReference": "bbb1"
    }
  ]
}