payments

post

https://gw.edu-nation.net/api/payments

Returns list of payments (including refunds) within a given date range. For each payment, you will get the full details including: added on date, issue date, receipt number, student name, paid by, amount, and payment method details.
You can use the "additional_fields" parameter to include more fields in the JSON results. Check the /fields service to explore the additional fields that you can add.
Example:

{
"additional_fields":"customField_35,idnumber,countryName"
}

Rate Limit: MEDIUM

Permission needed: Financial Reports (#400)

Reference Code: srv_54

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

issueDate

string

required

Issue Date
Date range value.
Format: Comma separated dates: yyyy-MM-dd HH:mm:ss,yyyy-MM-dd HH:mm:ss

paymentMethodId

string

Payment Method
Format: Comma separated numbers, i.e. 23,24,25

amount

string

Amount
Number range value.
Format: Comma separated two numbers:-100,100

dueDate

string

Due Date
Date range value.
Format: Comma separated dates: yyyy-MM-dd HH:mm:ss,yyyy-MM-dd HH:mm:ss

studentName

string

Student Name

string

groupId

string

Group
Format: Comma separated numbers, i.e. 23,24,25

receiptCode

string

Receipt #
Number range value.
Format: Comma separated two numbers:-100,100

receiptStatus

integer

Defaults to 1

Receipt status

userStatus

integer

Student status

createdBy

string

Created by
Format: Comma separated numbers, i.e. 23,24,25

paymentTagId

string

Payment tag

feeTypeId

string

Fee type
Format: Comma separated numbers, i.e. 23,24,25

yearId

integer

Year

createdAt

string

Created at
Date range value.
Format: Comma separated dates: yyyy-MM-dd HH:mm:ss,yyyy-MM-dd HH:mm:ss

additional_fields

string

Include more fields in the JSON results. Check the /fields service to explore the additional fields that you can add.
Format: {"additional_fields":"customField_35,idnumber,countryName"}

Headers

client_secret

string

required

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

404Error