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
| Action | Endpoint | Allowed when the leg is |
|---|---|---|
| Release | POST /api/public/split-payments/{id}/legs/{legId}/release | held or failed |
| Hold | POST /api/public/split-payments/{id}/legs/{legId}/hold | waiting or released |
| Cancel | POST /api/public/split-payments/{id}/legs/{legId}/cancel | waiting, held, released, failed, or awaiting_cash_out |
| Send as pending | POST /api/public/split-payments/{id}/legs/{legId}/send-pending | held with failureReason no_bank_account |
| Release all | POST /api/public/split-payments/{id}/release-all | Any held leg. No change if none is held |
| Mark paid | POST /api/public/split-payments/{id}/legs/{legId}/mark-paid | instructed |
These endpoints take no body. An optional Idempotency-Key header runs a repeated request only once.
URI Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| id | number | Split payment ID | yes |
| legId | number | Leg ID | yes, 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
instructedtopaid. 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
payoutModedoes not allow the action
Pro tipFor a commission paid 30 days after a sale, create the payment with
"releaseMode": "manual", then release the leg after 30 days.
ImportantWe never send a
directleg without a bank account. Without one at release, we hold the leg withfailureReasonno_bank_account. Add a bank for the carrier and release the leg, or send it as pending.
Updated 9 days ago