New service | Last updated: 01 July 2025
Testing
Use the partyReference value in your Split Payments creation call, to trigger different outcomes.
Test scenarios
Input these magic values in your partyReference parameter:
| Magic value | Result code response | Description |
|---|---|---|
| any | 201 | Returns successful response |
beneficialOwnerNotVerified | 422 | One or more individual has not been verified as part of the Parties API identity verification. For example: a party has three beneficial owners and one of the three has not being verified successfully. |
partyNotVerified | 422 | A party did not pass the necessary checks required as part of the Parties API identity verification or no beneficialOwners added to a party of type. |
noBalanceAccount | 422 | A party exists, but the settlement currency account is not valid/does not exist. You must create a balance account through our Parties API. |
noPayoutSchedule | 422 | A party exists, but does not have a payout schedule set up. You must assign a payout schedule through our Parties API. |
noPayoutInstrument | 422 | A party exists, but there is no payoutInstrument available for the settlement currency. You must create a payout instrument through our Parties API. |
partyTypePayer | 422 | A party type Payer cannot be used for Pay-In. |
Example
{
"reference": "5D262CB9-57F2-4176-AA7C-B76A79284277",
"description": "optional split payment description",
"fulfillment": {
"auto": false,
"paymentCommandId": "cmdd1dcd2dee333cae1bfdeb0"
},
"merchant": {
"entity": "default"
},
"value": {
"currency": "GBP",
"totalAmount": 300
},
"lineItems": [
{
"itemReference": "aaaaaaa",
"partyReference": "beneficialOwnerNotVerified",
"amount": 250,
"description": "Item description",
"deductions": [
{
"type": "commission",
"value": {
"type": "percentage",
"amount": 75
},
"description": "Deduction description"
}
]
}
]
}