Manage split legs

These endpoints release, hold, or cancel one leg, or release all held legs. Each action sends the split_leg_status_changed webhook. Mark paid works only in instructions mode. Other actions work only in managed mode.

Request

ActionEndpointAllowed when the leg is
ReleasePOST /api/public/split-payments/{id}/legs/{legId}/releaseheld or failed
HoldPOST /api/public/split-payments/{id}/legs/{legId}/holdwaiting or released
CancelPOST /api/public/split-payments/{id}/legs/{legId}/cancelwaiting, held, released, failed, or awaiting_cash_out
Send as pendingPOST /api/public/split-payments/{id}/legs/{legId}/send-pendingheld with failureReason no_bank_account
Release allPOST /api/public/split-payments/{id}/release-allAny held leg. No change if none is held
Mark paidPOST /api/public/split-payments/{id}/legs/{legId}/mark-paidinstructed

These endpoints take no body. An optional Idempotency-Key header runs a repeated request only once.

URI Parameters

NameTypeDescriptionRequired
idnumberSplit payment IDyes
legIdnumberLeg IDyes, except Release all

Actions

  • Release sends a held leg. It also resends a failed leg, for example after the payee fixes its bank account.
  • Hold stops a leg before we send it. You can release it later.
  • Cancel stops a leg permanently. The amount goes to your Trust Account.
  • Send as pending emails the payee to cash out by bank transfer, Venmo, or paper check. The leg moves to awaiting_cash_out.
  • Mark paid records that you paid the payee yourself. The leg moves from instructed to paid. We never move money for this leg.

Response

A successful request returns a 200 OK status code with the split payment. See Get split payment.

Error Responses

  • 404 Not Found: Split payment or leg not found, or it belongs to another account
  • 409 Conflict: The leg status or payoutMode does not allow the action
📘

Pro tip

For a commission paid 30 days after a sale, create the payment with "releaseMode": "manual", then release the leg after 30 days.

❗️

Important

We never send a direct leg without a bank account. Without one at release, we hold the leg with failureReason no_bank_account. Add a bank for the carrier and release the leg, or send it as pending.


Did this page help you?