Statements
This document lays out the specification of interacting with the Qgiv Statements system, allowing for reading of Statements.
GET : https://secure.qgiv.com/admin/api/reporting/statements/list
Returns all statements associated with the current form or organization
{
"statements": [
{
"id": "13594",
"amountContributed": "13.48",
"refunded": null,
"percentage": "3.50",
"flatFee": "0.00",
"transactionFees": "8.89",
"monthlyFee": "0.00",
"setupFee": "0.00",
"debited": "8.89",
"date": "2012-03-01",
"dateDebited": "2012-11-05",
"credited": "0.00",
"totalSetupFees": null,
"setupFees": [],
"transactionSummary": {
"transactions": [
{
"id": "227429",
"timestamp": "03/18/2012",
"name": "Qgiv User",
"paymentType": "Visa",
"amount": "1.25",
"fees": "0.04",
"withFees": 1.29,
"refundAmount": "1.25",
"paymentSource": "Public Form",
"state": "A"
},
...
],
"totalTransactions": 16,
"subTotal": 13.48,
"total": 13.48,
"feeTotal": 0.52,
"refundTotal": 4.25
}
},
...
]
}
Libraries to use :
using System.Net;
using System.Text;
using System.IO;
string postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP";
HttpWebResponse resp = null;
string result = null;
try {
HttpWebRequest req = WebRequest.Create(new Uri("https://secure.qgiv.com/admin/api/reporting/statements/list.xml")) as HttpWebRequest;
req.Method = "POST";
req.Accept = "*/*";
req.UserAgent = "http_request/0.1";
req.Timeout = 50000;
req.ContentType = "application/x-www-form-urlencoded";
byte[] formData = UTF8Encoding.UTF8.GetBytes(postData);
using (Stream post = req.GetRequestStream()) {
post.Write(formData, 0, formData.Length);
}
// Pick up the response:
resp = req.GetResponse() as HttpWebResponse;
if (resp.StatusCode == System.Net.HttpStatusCode.OK) {
using (resp) {
StreamReader reader =
new StreamReader(resp.GetResponseStream());
result = reader.ReadToEnd();
}
}
} catch (Exception e) {
result = "error : " + e.Message;
}
String data = URLEncoder.encode("token", "UTF-8") + "=" + URLEncoder.encode("skyMV9YeaxQ7EjbEUHt8TUiP", "UTF-8");
URL url = new URL("https://secure.qgiv.com/admin/api/reporting/statements/list.xml");
URLConnection conn = url.openConnection();
conn.setDoOutput(true);
OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
wr.write(data);
wr.flush();
BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String line;
String output;
while ((line = rd.readLine()) != null) {
output += line;
}
wr.close();
rd.close();
return output;
var apiRequest = false;
var url = "https://secure.qgiv.com/admin/api/reporting/statements/list.xml";
var postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP";
var results;
var isIE8 = window.XDomainRequest ? true : false;
if (typeof XMLHttpRequest != "undefined") {
if(isIE8) {
apiRequest = new Window.XDomainRequest()
} else {
apiRequest = new XMLHttpRequest();
}
} else if (window.ActiveXObject) {
var ieVersions = ["MSXML2.XMLHttp.5.0","MSXML2.XMLHttp.4.0","MSXML2.XMLHttp.3.0","MSXML2.XMLHttp","Microsoft.XMLHttp"];
for (var i = 0; i < ieVersions.length; i++) {
try {
apiRequest = new ActiveXObject(aVersions[i]);
} catch(oError) {
throw new Error("XMLHttp object could be created.");
}
}
}
if (!apiRequest) {
alert("An error has occuerd while creating XMLHttpRequest object");
}
if (apiRequest) {
apiRequest.open("POST", url, true);
apiRequest.onreadystatechange = handleResponse;
apiRequest.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
apiRequest.send(postData);
}
function handleResponse() {
if (apiRequest.readyState == 4) {
if (apiRequest.status == 200) {
results = apiRequest.responseText;
} else {
results = "Server response is unsuccessful";
}
} else {
results = "Server response is incomplete"
}
}
$postArray = array(
'token' => '[your API token]'
);
$postString = http_build_query($postArray);
$url = 'https://secure.qgiv.com/admin/api/reporting/statements/list.xml';
$curlHandler = curl_init();
curl_setopt($curlHandler, CURLOPT_URL, $url);
curl_setopt($curlHandler, CURLOPT_POST, true);
curl_setopt($curlHandler, CURLOPT_POSTFIELDS, $postString);
curl_setopt($curlHandler, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYHOST, false);
$response = curl_exec($curlHandler);
if (curl_errno($curlHandler)) {
$response = 'error : '.curl_error($curlHandler);
} else {
curl_close($curlHandler);
}
return $response;
import urllib, urllib2
postArray = {
'token' => '[your API token]'
}
postString = urllib.urlencode(postArray)
url = 'https://secure.qgiv.com/admin/api/reporting/statements/list.xml';
request = urllib2.Request(url, data=data)
try:
response = urllib2.urlopen(request)
result = response.read()
response.close()
except urllib2.URLError, e:
result = 'error : ' + str(e.code)
return result
GET : https://secure.qgiv.com/admin/api/reporting/statements/[id]
Returns the statement requested, individually specified by ID.
{
"statement": {
"id": "13594",
"amountContributed": "13.48",
"refunded": null,
"percentage": "3.50",
"flatFee": "0.00",
"transactionFees": "8.89",
"monthlyFee": "0.00",
"setupFee": "0.00",
"debited": "8.89",
"date": "2011-03-01",
"dateDebited": "2011-11-05",
"credited": "0.00",
"totalSetupFees": null,
"setupFees": [],
"transactionSummary": {
"transactions": [
{
"timestamp": "03/18/2011",
"name": "Qgiv User",
"paymentType": "Visa",
"amount": "1.25",
"fees": "0.04",
"withFees": 1.29,
"refundAmount": "1.25",
"paymentSource": "Public Form",
"state": "A"
},
...
],
"totalTransactions": 16,
"subTotal": 13.48,
"total": 13.48,
"feeTotal": 0.52,
"refundTotal": 4.25
}
}
}
Libraries to use :
using System.Net;
using System.Text;
using System.IO;
string postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP";
HttpWebResponse resp = null;
string result = null;
try {
HttpWebRequest req = WebRequest.Create(new Uri("https://secure.qgiv.com/admin/api/reporting/statements/13594.xml")) as HttpWebRequest;
req.Method = "POST";
req.Accept = "*/*";
req.UserAgent = "http_request/0.1";
req.Timeout = 50000;
req.ContentType = "application/x-www-form-urlencoded";
byte[] formData = UTF8Encoding.UTF8.GetBytes(postData);
using (Stream post = req.GetRequestStream()) {
post.Write(formData, 0, formData.Length);
}
// Pick up the response:
resp = req.GetResponse() as HttpWebResponse;
if (resp.StatusCode == System.Net.HttpStatusCode.OK) {
using (resp) {
StreamReader reader =
new StreamReader(resp.GetResponseStream());
result = reader.ReadToEnd();
}
}
} catch (Exception e) {
result = "error : " + e.Message;
}
String data = URLEncoder.encode("token", "UTF-8") + "=" + URLEncoder.encode("skyMV9YeaxQ7EjbEUHt8TUiP", "UTF-8");
URL url = new URL("https://secure.qgiv.com/admin/api/reporting/statements/13594.xml");
URLConnection conn = url.openConnection();
conn.setDoOutput(true);
OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
wr.write(data);
wr.flush();
BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String line;
String output;
while ((line = rd.readLine()) != null) {
output += line;
}
wr.close();
rd.close();
return output;
var apiRequest = false;
var url = "https://secure.qgiv.com/admin/api/reporting/statements/13594.xml";
var postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP";
var results;
var isIE8 = window.XDomainRequest ? true : false;
if (typeof XMLHttpRequest != "undefined") {
if(isIE8) {
apiRequest = new Window.XDomainRequest()
} else {
apiRequest = new XMLHttpRequest();
}
} else if (window.ActiveXObject) {
var ieVersions = ["MSXML2.XMLHttp.5.0","MSXML2.XMLHttp.4.0","MSXML2.XMLHttp.3.0","MSXML2.XMLHttp","Microsoft.XMLHttp"];
for (var i = 0; i < ieVersions.length; i++) {
try {
apiRequest = new ActiveXObject(aVersions[i]);
} catch(oError) {
throw new Error("XMLHttp object could be created.");
}
}
}
if (!apiRequest) {
alert("An error has occuerd while creating XMLHttpRequest object");
}
if (apiRequest) {
apiRequest.open("POST", url, true);
apiRequest.onreadystatechange = handleResponse;
apiRequest.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
apiRequest.send(postData);
}
function handleResponse() {
if (apiRequest.readyState == 4) {
if (apiRequest.status == 200) {
results = apiRequest.responseText;
} else {
results = "Server response is unsuccessful";
}
} else {
results = "Server response is incomplete"
}
}
$postArray = array(
'token' => '[your API token]'
);
$postString = http_build_query($postArray);
$url = 'https://secure.qgiv.com/admin/api/reporting/statements/13594.xml';
$curlHandler = curl_init();
curl_setopt($curlHandler, CURLOPT_URL, $url);
curl_setopt($curlHandler, CURLOPT_POST, true);
curl_setopt($curlHandler, CURLOPT_POSTFIELDS, $postString);
curl_setopt($curlHandler, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYHOST, false);
$response = curl_exec($curlHandler);
if (curl_errno($curlHandler)) {
$response = 'error : '.curl_error($curlHandler);
} else {
curl_close($curlHandler);
}
return $response;
import urllib, urllib2
postArray = {
'token' => '[your API token]'
}
postString = urllib.urlencode(postArray)
url = 'https://secure.qgiv.com/admin/api/reporting/statements/13594.xml';
request = urllib2.Request(url, data=data)
try:
response = urllib2.urlopen(request)
result = response.read()
response.close()
except urllib2.URLError, e:
result = 'error : ' + str(e.code)
return result
GET : https://secure.qgiv.com/admin/api/reporting/statements/latest
Returns the latest statements for the current Organization or Form.
{
"statements": [
{
"id": "13594",
"amountContributed": "13.48",
"refunded": null,
"percentage": "3.50",
"flatFee": "0.00",
"transactionFees": "8.89",
"monthlyFee": "0.00",
"setupFee": "0.00",
"debited": "8.89",
"date": "2012-03-01",
"dateDebited": "2012-11-05",
"credited": "0.00",
"totalSetupFees": null,
"setupFees": [],
"transactionSummary": {
"transactions": [
{
"id": "227429",
"timestamp": "03/18/2012",
"name": "Qgiv User",
"paymentType": "Visa",
"amount": "1.25",
"fees": "0.04",
"withFees": 1.29,
"refundAmount": "1.25",
"paymentSource": "Public Form",
"state": "A"
},
...
],
"totalTransactions": 16,
"subTotal": 13.48,
"total": 13.48,
"feeTotal": 0.52,
"refundTotal": 4.25
}
},
...
]
}
Libraries to use :
using System.Net;
using System.Text;
using System.IO;
string postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP";
HttpWebResponse resp = null;
string result = null;
try {
HttpWebRequest req = WebRequest.Create(new Uri("https://secure.qgiv.com/admin/api/reporting/statements/latest.xml")) as HttpWebRequest;
req.Method = "POST";
req.Accept = "*/*";
req.UserAgent = "http_request/0.1";
req.Timeout = 50000;
req.ContentType = "application/x-www-form-urlencoded";
byte[] formData = UTF8Encoding.UTF8.GetBytes(postData);
using (Stream post = req.GetRequestStream()) {
post.Write(formData, 0, formData.Length);
}
// Pick up the response:
resp = req.GetResponse() as HttpWebResponse;
if (resp.StatusCode == System.Net.HttpStatusCode.OK) {
using (resp) {
StreamReader reader =
new StreamReader(resp.GetResponseStream());
result = reader.ReadToEnd();
}
}
} catch (Exception e) {
result = "error : " + e.Message;
}
String data = URLEncoder.encode("token", "UTF-8") + "=" + URLEncoder.encode("skyMV9YeaxQ7EjbEUHt8TUiP", "UTF-8");
URL url = new URL("https://secure.qgiv.com/admin/api/reporting/statements/latest.xml");
URLConnection conn = url.openConnection();
conn.setDoOutput(true);
OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
wr.write(data);
wr.flush();
BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String line;
String output;
while ((line = rd.readLine()) != null) {
output += line;
}
wr.close();
rd.close();
return output;
var apiRequest = false;
var url = "https://secure.qgiv.com/admin/api/reporting/statements/latest.xml";
var postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP";
var results;
var isIE8 = window.XDomainRequest ? true : false;
if (typeof XMLHttpRequest != "undefined") {
if(isIE8) {
apiRequest = new Window.XDomainRequest()
} else {
apiRequest = new XMLHttpRequest();
}
} else if (window.ActiveXObject) {
var ieVersions = ["MSXML2.XMLHttp.5.0","MSXML2.XMLHttp.4.0","MSXML2.XMLHttp.3.0","MSXML2.XMLHttp","Microsoft.XMLHttp"];
for (var i = 0; i < ieVersions.length; i++) {
try {
apiRequest = new ActiveXObject(aVersions[i]);
} catch(oError) {
throw new Error("XMLHttp object could be created.");
}
}
}
if (!apiRequest) {
alert("An error has occuerd while creating XMLHttpRequest object");
}
if (apiRequest) {
apiRequest.open("POST", url, true);
apiRequest.onreadystatechange = handleResponse;
apiRequest.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
apiRequest.send(postData);
}
function handleResponse() {
if (apiRequest.readyState == 4) {
if (apiRequest.status == 200) {
results = apiRequest.responseText;
} else {
results = "Server response is unsuccessful";
}
} else {
results = "Server response is incomplete"
}
}
$postArray = array(
'token' => '[your API token]'
);
$postString = http_build_query($postArray);
$url = 'https://secure.qgiv.com/admin/api/reporting/statements/latest.xml';
$curlHandler = curl_init();
curl_setopt($curlHandler, CURLOPT_URL, $url);
curl_setopt($curlHandler, CURLOPT_POST, true);
curl_setopt($curlHandler, CURLOPT_POSTFIELDS, $postString);
curl_setopt($curlHandler, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYHOST, false);
$response = curl_exec($curlHandler);
if (curl_errno($curlHandler)) {
$response = 'error : '.curl_error($curlHandler);
} else {
curl_close($curlHandler);
}
return $response;
import urllib, urllib2
postArray = {
'token' => '[your API token]'
}
postString = urllib.urlencode(postArray)
url = 'https://secure.qgiv.com/admin/api/reporting/statements/latest.xml';
request = urllib2.Request(url, data=data)
try:
response = urllib2.urlopen(request)
result = response.read()
response.close()
except urllib2.URLError, e:
result = 'error : ' + str(e.code)
return result
* denotes a required field
** denotes a required field based on Event settings
*** denotes a field that is only required when submitting Form level API credentials