Appearance
Payment Link
payments.payment_link · numbered PL-{YYYY}-{#####}
Fields
Every record also has id, created_at and updated_at.
| Field | Label | Type | Rules |
|---|---|---|---|
purpose | purpose | text | required; max 40 characters |
student | student | link → core.student | |
customer_name | customer name | text | required; personal data; max 100 characters |
customer_email | customer email | required; personal data | |
customer_phone | customer phone | phone | required; personal data |
email_subject | email subject | text | required; max 200 characters |
description | description | longtext | required; max 2000 characters |
amount | amount | money | required; min 1 |
currency | currency | select | one of: INR; default "INR" |
valid_for | valid for | number | required; min 1 |
valid_unit | valid unit | select | one of: Minutes, Hours, Days; default "Days" |
delivery | delivery | select | one of: Email, SMS, Both; default "Email" |
settlement_account | settlement account | link → payments.settlement_account | required |
gateway_invoice_id | gateway invoice id | text | max 80 characters |
link_url | link url | text | max 400 characters |
status | status | select | one of: Draft, Sent, Paid, Expired, Failed; default "Draft" |
Permissions
| Role | Can |
|---|---|
payments:admin | read, create, update |
payments:finance | read, create, update |
payments:viewer | read |
API
http
GET /api/payments/payment_link?<field>=<value>&limit=100&offset=0
POST /api/payments/payment_link
GET /api/payments/payment_link/:id
PATCH /api/payments/payment_link/:id
DELETE /api/payments/payment_link/:id