Skip to content

Payment Order ​

payments.payment_order · numbered ORD-{YYYY}-{########}

Fields ​

Every record also has id, created_at and updated_at.

FieldLabelTypeRules
purposepurposetextrequired; max 40 characters
requested_by_modulerequested by moduletextrequired; max 40 characters
referencereferencetextrequired; max 80 characters
reference_itemsreference itemstextmax 400 characters
studentstudentlink → core.student
payerpayerlink → core.user
payer_namepayer nametextpersonal data; max 140 characters
payer_emailpayer emailemailpersonal data
payer_phonepayer phonephonepersonal data
collegecollegelink → core.college
amountamountmoneyrequired; min 1
extra_amountextra amountmoneydefault 0; min 0
currencycurrencyselectone of: INR; default "INR"
modemodeselectone of: Online, Cash, Cheque, Demand draft, NEFT, RTGS, UPI; default "Online"
providerproviderselectone of: CCAvenue, Razorpay, PayU, Offline; default "CCAvenue"
order_typeorder typeselectone of: Order, Invoice, Order (subscription), Partial pay, Snippet; default "Order"
settlement_accountsettlement accountlink → payments.settlement_account
statusstatusselectone of: Created, Initiated, Success, Failure, Aborted, Timeout, Invalid, Awaiting settlement; default "Created"
status_messagestatus messagetextmax 400 characters
gateway_order_idgateway order idtextmax 80 characters
tracking_idtracking idtextmax 80 characters
payment_linkpayment linklink → payments.payment_link
lookup_attemptslookup attemptsnumberdefault 0; min 0
event_deliveredevent deliveredcheckdefault false
return_urlreturn urltextmax 400 characters

Unique together: requested_by_module + reference + gateway_order_id

Permissions ​

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

API ​

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

Edulab Bench developer documentation