Splits

Generated page, from the OpenAPI specification the gateway serves (GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.

Method	Path	Description
GET	/v1/payments/{id}/splits	The shares of a payment
POST	/v1/payments/{id}/splits	Split a payment

GET /v1/payments/{id}/splits

The shares of a payment

The shares already allocated, with their settlement state.

Parameters

Name	In	Required	Description
id	path	yes

Responses

• 200 — OK (object)
• 401 — API key missing or rejected (Error)
• 403 — The key does not carry the required scope, or the account is not active (Error)
• 404 — No payment with that identifier (Error)
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)

POST /v1/payments/{id}/splits

Split a payment

Allocates shares of a successful payment to other accounts on the platform — what a marketplace does when it pays its sellers.

⚠️ THE SPLIT IS WRITTEN IN THE SAME TRANSACTION AS THE PAYMENT, which makes it impossible to split more than was collected: the parent is revalidated under lock and the whole thing is refused rather than part of it. A marketplace splitting in two steps would have to handle “collected but not yet split”; that state does not exist here.

fee_minor is TAKEN OUT OF amount_minor, not added on top: the beneficiary receives amount − fee.

Parameters

Name	In	Required	Description
id	path	yes	The payment to split: identifier, reference, or your client_ref.
Idempotency-Key	header	no	An idempotency key specific to THIS operation.

Request body

Field	Type	Required	Description
splits	object[]	yes
splits[].beneficiary_id	string	yes	The beneficiary account, by its PUBLIC id. It must be active, and it cannot be your own.
splits[].amount_minor	string	yes	Amount in MINOR UNITS, as a string. The asset's decimal count comes from GET /v1/assets.
splits[].fee_minor	string	no	Your commission on this share. Absent = 0.
splits[].description	string	no

Responses

• 201 — Shares created (object)
• 401 — API key missing or rejected (Error)
• 403 — The key does not carry the required scope, or the account is not active (Error)
• 404 — No payment with that identifier on this account (Error)
• 422 — Beneficiary unknown or inactive, beneficiary equal to yourself, operation not collected, or total greater than the parent (Error)
• 429 — The key's request budget is exhausted (300/min) — honour Retry-After (Error)

Schemas

The shapes the operations above return.

Error

Field	Type	Description
error	object
error.code	string
error.message	string