POST api/IdealRPay/getPayments
Request Information
URI Parameters
None.
Body Parameters
clsStudentAppUsersRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| FromDate | date |
None. |
|
| ToDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"FromDate": "2025-12-13T10:12:17.1169644+05:30",
"ToDate": "2025-12-13T10:12:17.1169644+05:30"
}
application/xml, text/xml
Sample:
<clsStudentAppUsersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LiveTextBooksModel.Entity"> <FromDate>2025-12-13T10:12:17.1169644+05:30</FromDate> <ToDate>2025-12-13T10:12:17.1169644+05:30</ToDate> </clsStudentAppUsersRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of clsPayment| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
None. |
|
| entity | string |
None. |
|
| amount | integer |
None. |
|
| currency | string |
None. |
|
| status | string |
None. |
|
| order_id | Object |
None. |
|
| invoice_id | Object |
None. |
|
| international | boolean |
None. |
|
| method | string |
None. |
|
| amount_refunded | integer |
None. |
|
| refund_status | Object |
None. |
|
| captured | boolean |
None. |
|
| description | string |
None. |
|
| card_id | Object |
None. |
|
| bank | string |
None. |
|
| wallet | Object |
None. |
|
| vpa | Object |
None. |
|
| string |
None. |
||
| contact | string |
None. |
|
| notes | PaymentNotes |
None. |
|
| fee | Object |
None. |
|
| tax | Object |
None. |
|
| error_code | string |
None. |
|
| error_description | string |
None. |
|
| error_source | string |
None. |
|
| error_step | string |
None. |
|
| error_reason | string |
None. |
|
| acquirer_data | AcquirerData |
None. |
|
| created_at | integer |
None. |
|
| CreatedON | date |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"id": "sample string 1",
"entity": "sample string 2",
"amount": 3,
"currency": "sample string 4",
"status": "sample string 5",
"order_id": {},
"invoice_id": {},
"international": true,
"method": "sample string 9",
"amount_refunded": 10,
"refund_status": {},
"captured": true,
"description": "sample string 13",
"card_id": {},
"bank": "sample string 15",
"wallet": {},
"vpa": {},
"email": "sample string 18",
"contact": "sample string 19",
"notes": {
"app_name": "sample string 1",
"standard": "sample string 2",
"package_name": "sample string 3",
"package_id": "sample string 4",
"user_id": "sample string 5",
"user_name": "sample string 6"
},
"fee": {},
"tax": {},
"error_code": "sample string 22",
"error_description": "sample string 23",
"error_source": "sample string 24",
"error_step": "sample string 25",
"error_reason": "sample string 26",
"acquirer_data": {
"bank_transaction_id": {}
},
"created_at": 27,
"CreatedON": "2025-12-13T10:12:17.132588+05:30"
},
{
"id": "sample string 1",
"entity": "sample string 2",
"amount": 3,
"currency": "sample string 4",
"status": "sample string 5",
"order_id": {},
"invoice_id": {},
"international": true,
"method": "sample string 9",
"amount_refunded": 10,
"refund_status": {},
"captured": true,
"description": "sample string 13",
"card_id": {},
"bank": "sample string 15",
"wallet": {},
"vpa": {},
"email": "sample string 18",
"contact": "sample string 19",
"notes": {
"app_name": "sample string 1",
"standard": "sample string 2",
"package_name": "sample string 3",
"package_id": "sample string 4",
"user_id": "sample string 5",
"user_name": "sample string 6"
},
"fee": {},
"tax": {},
"error_code": "sample string 22",
"error_description": "sample string 23",
"error_source": "sample string 24",
"error_step": "sample string 25",
"error_reason": "sample string 26",
"acquirer_data": {
"bank_transaction_id": {}
},
"created_at": 27,
"CreatedON": "2025-12-13T10:12:17.132588+05:30"
}
]
application/xml, text/xml
Sample:
<ArrayOfclsPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LiveTextBooksModel.Entity">
<clsPayment>
<CreatedON>2025-12-13T10:12:17.132588+05:30</CreatedON>
<acquirer_data>
<bank_transaction_id />
</acquirer_data>
<amount>3</amount>
<amount_refunded>10</amount_refunded>
<bank>sample string 15</bank>
<captured>true</captured>
<card_id />
<contact>sample string 19</contact>
<created_at>27</created_at>
<currency>sample string 4</currency>
<description>sample string 13</description>
<email>sample string 18</email>
<entity>sample string 2</entity>
<error_code>sample string 22</error_code>
<error_description>sample string 23</error_description>
<error_reason>sample string 26</error_reason>
<error_source>sample string 24</error_source>
<error_step>sample string 25</error_step>
<fee />
<id>sample string 1</id>
<international>true</international>
<invoice_id />
<method>sample string 9</method>
<notes>
<app_name>sample string 1</app_name>
<package_id>sample string 4</package_id>
<package_name>sample string 3</package_name>
<standard>sample string 2</standard>
<user_id>sample string 5</user_id>
<user_name>sample string 6</user_name>
</notes>
<order_id />
<refund_status />
<status>sample string 5</status>
<tax />
<vpa />
<wallet />
</clsPayment>
<clsPayment>
<CreatedON>2025-12-13T10:12:17.132588+05:30</CreatedON>
<acquirer_data>
<bank_transaction_id />
</acquirer_data>
<amount>3</amount>
<amount_refunded>10</amount_refunded>
<bank>sample string 15</bank>
<captured>true</captured>
<card_id />
<contact>sample string 19</contact>
<created_at>27</created_at>
<currency>sample string 4</currency>
<description>sample string 13</description>
<email>sample string 18</email>
<entity>sample string 2</entity>
<error_code>sample string 22</error_code>
<error_description>sample string 23</error_description>
<error_reason>sample string 26</error_reason>
<error_source>sample string 24</error_source>
<error_step>sample string 25</error_step>
<fee />
<id>sample string 1</id>
<international>true</international>
<invoice_id />
<method>sample string 9</method>
<notes>
<app_name>sample string 1</app_name>
<package_id>sample string 4</package_id>
<package_name>sample string 3</package_name>
<standard>sample string 2</standard>
<user_id>sample string 5</user_id>
<user_name>sample string 6</user_name>
</notes>
<order_id />
<refund_status />
<status>sample string 5</status>
<tax />
<vpa />
<wallet />
</clsPayment>
</ArrayOfclsPayment>