Skip to content

Settlement (Payout) ​

payments.settlement

Fields ​

Every record also has id, created_at and updated_at.

FieldLabelTypeRules
pay_idpay idtextrequired; unique; max 80 characters
utr_noutr notextrequired; unique; max 80 characters
settlement_datesettlement datedaterequired
settlement_accountsettlement accountlink → payments.settlement_account
amountamountmoneyrequired
settlement_currencysettlement currencyselectone of: INR; default "INR"
transaction_currencytransaction currencyselectone of: INR; default "INR"
settlement_banksettlement banktextmax 140 characters
ifsc_codeifsc codetextmax 11 characters
account_number_last4account number last4textmax 4 characters
reconciledreconciledcheckdefault false

Permissions ​

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

API ​

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

Edulab Bench developer documentation