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

NameTypeDescriptionRequired
idnumberID of the split paymentno

Query Parameters

NameTypeDescriptionRequired
invoiceIdnumberReturn the split payment for this invoiceno
cardChargeIdnumberReturn the split payment for this card chargeno

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:

NameTypeDescription
idnumberID of the split payment
invoiceIdnumber | nullInvoice ID, if the payment is an invoice
cardChargeIdnumber | nullCard charge ID, if the payment is a card charge
payoutModestringmanaged or instructions
releaseModestring | nullautomatic or manual. null in instructions mode
collectedCentsintegerCollected from the policyholder, in cents
toTrustAccountCentsintegerAmount paid to your Trust Account, in cents: the amount no part covers, plus any canceled legs. In instructions mode, the full collected amount
settledAtstring | nullWhen the payment settled (ISO 8601)
partsarrayThe parts, each with reference, ruleSetId, ruleSetVersion, and amountCents
legsarrayThe legs (see Leg object)

Leg object

NameTypeDescription
idnumberID of the leg
carrierIdnumberID of the payee
partReferencestring | nullThe reference of the part it is paid from. A payee in two parts gets two legs
amountCentsintegerAmount this payee gets, in cents, before any payout fee
feeCentsintegerPayout fee taken from this leg, in cents. 0 when you pay the fees
payoutMethodstringdirect or pending
statusstringStatus of the leg (see Leg statuses)
failureReasonstring | nullWhy the leg was held or failed, such as no_bank_account
historyarrayEach status change, with status, at, and by (system or you)

Leg statuses

StatusDescription
waitingThe payment has not settled yet
heldThe leg waits for you to release it
releasedThe leg is about to be sent
submittedA direct leg is on its way to the payee's bank
paidThe payee received the leg
failedThe payee's bank rejected the leg. We pay nothing until you release it again or cancel it
awaiting_cash_outA pending leg was emailed to the payee, who has not cashed out yet. It follows the pending payment rules
canceledThe leg will not be paid
instructedYou 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

Did this page help you?