New service | Last updated: 14 May 2025

Important

This documentation is for preview purposes only.

Testing

Use the partyReference value to trigger different outcomes from Split Payments purchase creation call.

Test scenarios

Input these magic values in your partyReference parameter:

Magic valueResult code responseDescription
any200Returns successful response
noBusinessOwners400One or more party does not exist. You must create a party through our Parties API.
businessOwnerNotVerified400One or more individual has not been verified as part of the Parties API identity verification. For example: if a party has three beneficial owners and one of the three has not being verified successfully.
partyNotVerified400A party did not pass the necessary checks required as part of the Parties API identity verification.
noBalanceAccount400A party exists, but the settlement currency account is not valid/does not exist.

Example

{
"purchaseReference": "5D262CB9-57F2-4176-AA7C-B76A79284277",
"fulfillment": {
   "auto": false,
   "commandId": "cmdd1dcd2dee333cae1bfdeb0",
   "commandReference": "5D262CB9-57F2-4176-AA7C-B76A79284276"
},
"merchant": {
   "entity": "default
},
"narrative": {
   "line1": "Socks",
   "line2": "Sandals"
},
"value": {
   "currency": "GBP",
   "totalAmount": 50
},
"items": [
   {
     "itemReference": "aaa1",
     "partyReference": "noBusinessOwners",
     "amount": 30,
     "narrative": {
       "line1": "Socks"
     },
     "commission": {
       "narrative": {
         "line1": "Socks"
       },
       "amount": 3
     },
     "fee": {
       "narrative": {
         "line1": "Socks"
       },
       "amount": 2
     }
   },
   {
     "itemReference": "bbb1",
     "partyReference": "businessOwnerNotVerified",
     "amount": 20,
     "narrative": {
       "line1": "Sandals"
     },
     "commission": {
       "narrative": {
         "line1": "Sandals"
       },
       "amount": 3
     },
     "fee": {
       "narrative": {
         "line1": "Sandals"
       },
       "amount": 2
     }
   }
]
}