Get split payment
This endpoint returns a split payment with its parts and legs. We create one when we collect a payment with a split object.
Request
GET /api/public/split-payments/{id}
GET /api/public/split-payments?invoiceId={invoiceId}
GET /api/public/split-payments?cardChargeId={cardChargeId}
URI Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| id | number | ID of the split payment | no |
Query Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| invoiceId | number | Return the split payment for this invoice | no |
| cardChargeId | number | Return the split payment for this card charge | no |
Each form returns one split payment. A payment has at most one.
Response
A successful request returns a 200 OK status code with the split payment:
| Name | Type | Description |
|---|---|---|
| id | number | ID of the split payment |
| invoiceId | number | null | Invoice ID, if the payment is an invoice |
| cardChargeId | number | null | Card charge ID, if the payment is a card charge |
| payoutMode | string | managed or instructions |
| releaseMode | string | null | automatic or manual. null in instructions mode |
| collectedCents | integer | Collected from the policyholder, in cents |
| toTrustAccountCents | integer | Amount paid to your Trust Account, in cents: the amount no part covers, plus any canceled legs. In instructions mode, the full collected amount |
| settledAt | string | null | When the payment settled (ISO 8601) |
| parts | array | The parts, each with reference, ruleSetId, ruleSetVersion, and amountCents |
| legs | array | The legs (see Leg object) |
Leg object
| Name | Type | Description |
|---|---|---|
| id | number | ID of the leg |
| carrierId | number | ID of the payee |
| partReference | string | null | The reference of the part it is paid from. A payee in two parts gets two legs |
| amountCents | integer | Amount this payee gets, in cents, before any payout fee |
| feeCents | integer | Payout fee taken from this leg, in cents. 0 when you pay the fees |
| payoutMethod | string | direct or pending |
| status | string | Status of the leg (see Leg statuses) |
| failureReason | string | null | Why the leg was held or failed, such as no_bank_account |
| history | array | Each status change, with status, at, and by (system or you) |
Leg statuses
| Status | Description |
|---|---|
waiting | The payment has not settled yet |
held | The leg waits for you to release it |
released | The leg is about to be sent |
submitted | A direct leg is on its way to the payee's bank |
paid | The payee received the leg |
failed | The payee's bank rejected the leg. We pay nothing until you release it again or cancel it |
awaiting_cash_out | A pending leg was emailed to the payee, who has not cashed out yet. It follows the pending payment rules |
canceled | The leg will not be paid |
instructed | You pay this payee (instructions mode only). Stays instructed until you mark it paid |
A direct leg moves through waiting, released, submitted, and paid. A pending leg moves through waiting, released, awaiting_cash_out, and paid. In manual release mode, every leg moves from waiting to held first. In instructions mode, a leg moves from instructed to paid when you mark it paid.
Example
{
"id": 88,
"invoiceId": 9001,
"cardChargeId": null,
"payoutMode": "managed",
"releaseMode": "automatic",
"collectedCents": 100000,
"toTrustAccountCents": 0,
"settledAt": "2026-11-10T18:00:00.000Z",
"parts": [
{ "reference": null, "ruleSetId": 12, "ruleSetVersion": 1, "amountCents": 100000 }
],
"legs": [
{
"id": 301, "carrierId": 501, "partReference": null, "amountCents": 60000, "feeCents": 0, "payoutMethod": "direct",
"status": "paid", "failureReason": null,
"history": [
{ "status": "waiting", "at": "2026-11-09T15:05:00.000Z", "by": "system" },
{ "status": "released", "at": "2026-11-10T18:00:00.000Z", "by": "system" },
{ "status": "submitted", "at": "2026-11-10T18:00:05.000Z", "by": "system" },
{ "status": "paid", "at": "2026-11-11T14:00:00.000Z", "by": "system" }
]
},
{
"id": 302, "carrierId": 502, "partReference": null, "amountCents": 25000, "feeCents": 0, "payoutMethod": "direct",
"status": "held", "failureReason": "no_bank_account",
"history": [
{ "status": "waiting", "at": "2026-11-09T15:05:00.000Z", "by": "system" },
{ "status": "released", "at": "2026-11-10T18:00:00.000Z", "by": "system" },
{ "status": "held", "at": "2026-11-10T18:00:02.000Z", "by": "system" }
]
},
{
"id": 303, "carrierId": 503, "partReference": null, "amountCents": 15000, "feeCents": 0, "payoutMethod": "pending",
"status": "awaiting_cash_out", "failureReason": null,
"history": [
{ "status": "waiting", "at": "2026-11-09T15:05:00.000Z", "by": "system" },
{ "status": "released", "at": "2026-11-10T18:00:00.000Z", "by": "system" },
{ "status": "awaiting_cash_out", "at": "2026-11-10T18:00:04.000Z", "by": "system" }
]
}
]
}Error Responses
- 404 Not Found: The split payment does not exist until the payment is collected, or it belongs to another account
Updated 9 days ago
Did this page help you?