PopuliPayment

The PopuliPayment object

The PopuliPayment object looks like this in JSON:

{
    "object": "populi_payment",
    "id": 1,
    "amount": 199,
    "type": "auto_ach",
    "applied_by_id": null,
    "applied_time": "2010-11-29T18:17:41+00:00",
    "amount_available": 0,
    "status": null,
    "declined_reason": null,
    "sandbox": true
}

Attribute	Required	Data Type
id	No	int
amount	Yes	decimal
type	No	enum (auto_ach, manual_echeck, paper_check, manual_credit_card, auto_credit_card, processing)
applied_by_id	No	int
applied_time	No	datetime
amount_available	Yes	decimal
status	No	enum (auth_capture, pending, settled, declined, paper, processing, paper_pending)
declined_reason	No	text (300)
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/populipayments" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/populipayments',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/populipayments',
 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/populipayments"), 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/populipayments');
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": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "populi_payment",
            "id": 50,
            "amount": 598,
            "type": null,
            "applied_by_id": null,
            "applied_time": "2025-09-16T00:00:00+00:00",
            "amount_available": 0,
            "status": null,
            "declined_reason": null,
            "report_status": "SUCCESSFUL",
            "invoices": "111|37",
            "applied_by_name": null
        }
    ],
    "sandbox": true
}

These are payments your school made to pay for their monthly use of Populi.

HTTP Request

GET /populipayments

Parameters

None

Permissions

Only keys that have been granted Populi Account Administrator permissions may call this method.

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/populipayments/(populipayment)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/populipayments/(populipayment)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/populipayments/(populipayment)',
 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/populipayments/(populipayment)"), 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/populipayments/(populipayment)');
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": "populi_payment",
    "id": 1,
    "amount": 199,
    "type": "auto_ach",
    "applied_by_id": null,
    "applied_time": "2010-11-29T18:17:41+00:00",
    "amount_available": 0,
    "status": null,
    "declined_reason": null,
    "sandbox": true
}

Retrieves a specific PopuliPayment object.

HTTP Request

GET /populipayments/(populipayment)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

Only keys that have been granted Populi Account Administrator permissions may call this method.