API

All endpoints are on the university's own address, e.g. https://<university>.<platform domain>, and need a logged-in user. Each call only returns and changes what the user's roles allow (roles).

Entity	Endpoint
Gateway Refund	`/api/payments/gateway_refund`
Payment Link	`/api/payments/payment_link`
Payment Order	`/api/payments/payment_order`
Payment	`/api/payments/payment_transaction`
Settlement (Payout)	`/api/payments/settlement`
Settlement Account	`/api/payments/settlement_account`
Split Payout	`/api/payments/split_payout`

Events

Direction	Event
emits	`payments.payment.received`
emits	`payments.payment.failed`
emits	`payments.refund.completed`
emits	`payments.settlement.received`

Settings

Each university sets these from its admin screen.

Setting	Type	Default	Label
`provider`	select	`"CCAvenue"`	Payment gateway
`testMode`	check	`false`	Use the gateway's test environment
`splitSettlement`	check	`true`	Split each payment to college settlement accounts
`defaultSettlementAccount`	text	`""`	Settlement account code used when none is given
`orderLookupAfterMinutes`	number	`30`	Check an unfinished order with the gateway after (minutes)
`orderLookupMaxAttempts`	number	`5`	Times to check an unfinished order before marking it failed
`orderExpiryMinutes`	number	`60`	Minutes before an unpaid order expires
`payerReceiptEmail`	check	`false`	Email the payer a payment confirmation
`offlinePayments`	check	`true`	Allow finance staff to record offline payments
`currency`	select	`"INR"`	Currency