Skip to content

Payment ​

payments.payment_transaction · every change is kept in the audit log · numbered PAY-{YYYY}-{########}

Fields ​

Every record also has id, created_at and updated_at.

FieldLabelTypeRules
payment_orderpayment orderlink → payments.payment_orderrequired
purposepurposetextrequired; max 40 characters
referencereferencetextrequired; max 80 characters
studentstudentlink → core.student
collegecollegelink → core.college
providerproviderselectrequired; one of: CCAvenue, Razorpay, PayU, Offline
payment_typepayment typeselectone of: Online, Offline; default "Online"
modemodetextmax 60 characters
tracking_idtracking idtextrequired; unique; max 80 characters
bank_ref_nobank ref notextmax 80 characters
gateway_statusgateway statustextmax 40 characters
statusstatusselectone of: Success, Failure, Reversed, Refunded; default "Success"
currencycurrencyselectone of: INR; default "INR"
amountamountmoneyrequired; min 0
extra_amountextra amountmoneydefault 0; min 0
college_sharecollege sharemoneydefault 0
gateway_chargesgateway chargesmoneydefault 0
platform_shareplatform sharemoneydefault 0
settlement_accountsettlement accountlink → payments.settlement_account
split_statussplit statusselectone of: Pending, Done, Stopped, Not applicable; default "Pending"
refund_statusrefund statusselectone of: None, Pending, Done; default "None"
paid_atpaid atdatetimerequired
payer_namepayer nametextpersonal data; max 140 characters
payer_emailpayer emailemailpersonal data
payer_phonepayer phonephonepersonal data
billing_addressbilling addresslongtextpersonal data; max 1000 characters
recorded_byrecorded bylink → core.user
remarksremarkslongtextmax 2000 characters
event_deliveredevent deliveredcheckdefault false
delivery_attemptsdelivery attemptsnumberdefault 0; min 0
activeactivecheckdefault true

Permissions ​

RoleCan
payments:adminread, create, update
payments:financeread, create, update
payments:viewerread
payments:payerread — only own rows (via student)

API ​

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

Edulab Bench developer documentation