Skip to content

Split Payout ​

payments.split_payout

Fields ​

Every record also has id, created_at and updated_at.

FieldLabelTypeRules
payment_transactionpayment transactionlink → payments.payment_transactionrequired
settlement_accountsettlement accountlink → payments.settlement_accountrequired
amountamountmoneyrequired; min 0
commissioncommissionmoneydefault 0; min 0
gateway_referencegateway referencetextmax 80 characters
statusstatusselectone of: Pending, Done, Failed, Stopped; default "Pending"
errorerrortextmax 400 characters

Unique together: payment_transaction + settlement_account

Permissions ​

RoleCan
payments:adminread, create, update
payments:financeread, create, update
payments:viewerread

API ​

http
GET    /api/payments/split_payout?<field>=<value>&limit=100&offset=0
POST   /api/payments/split_payout
GET    /api/payments/split_payout/:id
PATCH  /api/payments/split_payout/:id
DELETE /api/payments/split_payout/:id

Edulab Bench developer documentation