Refund
The Refund object
The Refund object looks like this in JSON:
{
"object": "refund",
"id": 6,
"student_id": 1,
"transaction_id": 21,
"number": 1,
"amount": 100,
"online_payment_id": null,
"refund_source": null,
"reference_number": null,
"receipt_number": "ce9sfe5d2e",
"currency": "USD",
"exchange_rate": null,
"home_currency_amount": 100,
"treat_as_aid": false,
"organization_name": null,
"method": "other",
"paid_to_type": "person",
"paid_to_id": 2,
"sandbox": true
}
| Attribute | Required | Data Type |
|---|---|---|
| id | Yes | int |
| student_id | No | int |
| transaction_id | Yes | int |
| number | No | int |
| amount | Yes | decimal |
| online_payment_id | No | int |
| refund_source | No | enum (all, payments_credits, all_aid, federal_aid, non_federal_aid, aid_type) |
| reference_number | Yes | text (100) |
| receipt_number | No | text (50) |
| currency | No | text (3) |
| exchange_rate | No | decimal |
| home_currency_amount | Yes | decimal |
| treat_as_aid | Yes | bool |
| organization_name | No | text (100) |
| method | No | text |
| paid_to_type | No | text |
| paid_to_id | No | int |
| sandbox | No | bool |
show
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/refunds/(refund)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/refunds/(refund)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/refunds/(refund)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/refunds/(refund)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/refunds/(refund)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "refund",
"id": 6,
"student_id": 1,
"transaction_id": 21,
"number": 1,
"amount": 100,
"online_payment_id": null,
"refund_source": null,
"reference_number": null,
"receipt_number": "ce9sfe5d2e",
"currency": "USD",
"exchange_rate": null,
"home_currency_amount": 100,
"treat_as_aid": false,
"organization_name": null,
"method": "other",
"paid_to_type": "person",
"paid_to_id": 2,
"sandbox": true
}
Retrieves a specific Refund object.
HTTP Request
GET /refunds/(refund)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- transaction
- student
- payment_refunds
- credit_refunds
Permissions
One of the following roles is required to call this method:
- Financial Auditor
- Financial Admin
- Student Billing