<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head><title> </title><link rel="stylesheet" type="text/css" href="/Content/docs.css" /><link href="/Content/syntaxhighlighter_3.0.83/styles/shCore.css" rel="stylesheet" type="text/css" /><link href="/Content/syntaxhighlighter_3.0.83/styles/shThemeDefault.css" rel="stylesheet" type="text/css" /> <script type="text/javascript" src="/content/syntaxhighlighter_3.0.83/scripts/shCore.js"></script> <script type="text/javascript" src="/content/syntaxhighlighter_3.0.83/scripts/shAutoloader.js"></script> <script type="text/javascript" src="/content/jquery-1.6.1.min.js"></script> </head> <body style="background-color: #F2F2F2"> <div> <div style="background-color: #78256D; margin-left: auto; margin-right: auto; width: 900px; height: 30px; padding: 10px 0px 10px 0px;"> <div style="padding: 5px 10px 10px 25px; color: White; font-weight: bolder; font-size: 18px;">JustGiving API Documentation</div> </div> <div style="background-color: #FFFFFF; margin-left: auto; margin-right: auto; width: 900px; padding: 10px 0px 0px 0px; height: 100%; min-height: 1000px;"> <div style="padding: 10px 0px 0px 25px; float: left; width: 130px;"> <h2>Getting Started</h2> <h1><a href="/docs">First Steps</a></h1> <h2>Resources</h2> <a href="/docs/resources/v1/CustomCodes">CustomCodes</a><br /> <a href="/docs/resources/v1/PagesCreated">PagesCreated</a><br /> <a href="/docs/resources/v1/PagesModified">PagesModified</a><br /> <a href="/docs/resources/v1/Payment">Payment</a><br /> <h2>Using the API</h2> <a href="/docs/usage">Usage</a><br /> <a href="/docs/usage#gettingAccess">Getting Access</a><br /> <a href="/docs/usage#terminology">Terminology</a><br /> <a href="/docs/usage#api-keys">API Keys</a><br /> <a href="/docs/usage#contentTypes">Content Types</a><br /> <a href="/docs/usage#httpVerbs">HTTP Verbs</a><br /> <a href="/docs/usage#statusCodes">Status Codes</a><br /> <a href="/docs/usage#errors">Errors</a><br /> <a href="/docs/usage#protectedResources">Security</a><br /> <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">What is REST?</a><br /> <h2>API Keys</h2> <a href="https://developer.justgiving.com">API Key Portal</a><br /> </div> <div style="padding: 10px 25px 0px 0px; float: right; width: 700px;"> <div> <h1>paymentsListWithDates</h1> <div id="documentation-wrap"> <div class="section"> <div style="padding: 5px; height: 60px; border: 1px solid #78256D; background-color: #DCBEE0; margin-bottom: 15px;"> <div> <div> <span style="margin-right: 45px; font-weight: bolder;">Uri</span><span>/{apiKey}/v1/charity/{charityId}/payments/{date1};{date2}</span> </div> <div style="padding-top: 5px;"> <span style="margin-right: 25px; font-weight: bolder;">Verb</span> <span>GET </span> </div> <div style="padding-top: 5px;"> <span style="margin-right: 30px; font-weight: bolder;">Auth</span><span>Yes</span> </div> </div> </div> <div> <p></p> <p> Retrieves a list of payments made within a given period. Payment data available via this service currently goes back no more than three years. </p> </div> </div> <div class="section"> <ul> </ul> </div> <div class="section"> </div> <div class="section"> <h3>HTTP Status Codes</h3> <ul> <li>200 (OK) - The request succeeded</li> <li>400 (BadRequest) - The date range you provided exceeds three months</li> <li>404 (NotFound) - The payment does not exist</li> </ul> <div class="section"> <h3>Response Examples</h3> <div> <span style="margin-right: 10px;">View as:</span> <span style="margin-right: 10px;"><a href="#" onclick="$('.xml-example').hide(); $('.js-example').show(); return false;">Json</a></span> <span><a href="#" onclick=" $('.js-example').hide(); $('.xml-example').show(); return false;">Xml</a></span> </div> <div class="js-example"> <pre class="brush: js">[ { &quot;Account&quot;: &quot;1212121212&quot;, &quot;CardProcessingFee&quot;: 0, &quot;Commission&quot;: 5.2, &quot;Gross&quot;: 105, &quot;Net&quot;: 99.8, &quot;PaymentDate&quot;: &quot;\/Date(1600411324136+0000)\/&quot;, &quot;PaymentRef&quot;: 324234, &quot;PaymentType&quot;: 1, &quot;Url&quot;: &quot;https:\/\/dataapi.justgiving.com\/v1\/charity\/2233\/abc132\/payments\/123456&quot;, &quot;VAT&quot;: 4.1 }, { &quot;Account&quot;: &quot;1212121212&quot;, &quot;CardProcessingFee&quot;: 0, &quot;Commission&quot;: 5.2, &quot;Gross&quot;: 105, &quot;Net&quot;: 99.8, &quot;PaymentDate&quot;: &quot;\/Date(1600411324136+0000)\/&quot;, &quot;PaymentRef&quot;: 324234, &quot;PaymentType&quot;: 1, &quot;Url&quot;: &quot;https:\/\/dataapi.justgiving.com\/v1\/charity\/2233\/abc132\/payments\/123456&quot;, &quot;VAT&quot;: 4.1 }, { &quot;Account&quot;: &quot;1212121212&quot;, &quot;CardProcessingFee&quot;: 0, &quot;Commission&quot;: 5.2, &quot;Gross&quot;: 105, &quot;Net&quot;: 99.8, &quot;PaymentDate&quot;: &quot;\/Date(1600411324136+0000)\/&quot;, &quot;PaymentRef&quot;: 324234, &quot;PaymentType&quot;: 1, &quot;Url&quot;: &quot;https:\/\/dataapi.justgiving.com\/v1\/charity\/2233\/abc132\/payments\/123456&quot;, &quot;VAT&quot;: 4.1 }, { &quot;Account&quot;: &quot;1212121212&quot;, &quot;CardProcessingFee&quot;: 0, &quot;Commission&quot;: 5.2, &quot;Gross&quot;: 105, &quot;Net&quot;: 99.8, &quot;PaymentDate&quot;: &quot;\/Date(1600411324136+0000)\/&quot;, &quot;PaymentRef&quot;: 324234, &quot;PaymentType&quot;: 1, &quot;Url&quot;: &quot;https:\/\/dataapi.justgiving.com\/v1\/charity\/2233\/abc132\/payments\/123456&quot;, &quot;VAT&quot;: 4.1 }, { &quot;Account&quot;: &quot;1212121212&quot;, &quot;CardProcessingFee&quot;: 0, &quot;Commission&quot;: 5.2, &quot;Gross&quot;: 105, &quot;Net&quot;: 99.8, &quot;PaymentDate&quot;: &quot;\/Date(1600411324136+0000)\/&quot;, &quot;PaymentRef&quot;: 324234, &quot;PaymentType&quot;: 1, &quot;Url&quot;: &quot;https:\/\/dataapi.justgiving.com\/v1\/charity\/2233\/abc132\/payments\/123456&quot;, &quot;VAT&quot;: 4.1 } ]</pre> </div> <div class="xml-example" style="display: none;"> <pre class="brush: xml"> &lt;ArrayOfPayment xmlns:i=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt; &lt;Payment&gt; &lt;Account&gt;1212121212&lt;/Account&gt; &lt;CardProcessingFee&gt;0&lt;/CardProcessingFee&gt; &lt;Commission&gt;5.2&lt;/Commission&gt; &lt;Gross&gt;105&lt;/Gross&gt; &lt;Net&gt;99.8&lt;/Net&gt; &lt;PaymentDate&gt;2020-09-18T06:42:04.1367999+00:00&lt;/PaymentDate&gt; &lt;PaymentRef&gt;324234&lt;/PaymentRef&gt; &lt;PaymentType&gt;giftaid&lt;/PaymentType&gt; &lt;Url&gt;https://dataapi.justgiving.com/v1/charity/2233/abc132/payments/123456&lt;/Url&gt; &lt;VAT&gt;4.1&lt;/VAT&gt; &lt;/Payment&gt; &lt;Payment&gt; &lt;Account&gt;1212121212&lt;/Account&gt; &lt;CardProcessingFee&gt;0&lt;/CardProcessingFee&gt; &lt;Commission&gt;5.2&lt;/Commission&gt; &lt;Gross&gt;105&lt;/Gross&gt; &lt;Net&gt;99.8&lt;/Net&gt; &lt;PaymentDate&gt;2020-09-18T06:42:04.1367999+00:00&lt;/PaymentDate&gt; &lt;PaymentRef&gt;324234&lt;/PaymentRef&gt; &lt;PaymentType&gt;giftaid&lt;/PaymentType&gt; &lt;Url&gt;https://dataapi.justgiving.com/v1/charity/2233/abc132/payments/123456&lt;/Url&gt; &lt;VAT&gt;4.1&lt;/VAT&gt; &lt;/Payment&gt; &lt;Payment&gt; &lt;Account&gt;1212121212&lt;/Account&gt; &lt;CardProcessingFee&gt;0&lt;/CardProcessingFee&gt; &lt;Commission&gt;5.2&lt;/Commission&gt; &lt;Gross&gt;105&lt;/Gross&gt; &lt;Net&gt;99.8&lt;/Net&gt; &lt;PaymentDate&gt;2020-09-18T06:42:04.1367999+00:00&lt;/PaymentDate&gt; &lt;PaymentRef&gt;324234&lt;/PaymentRef&gt; &lt;PaymentType&gt;giftaid&lt;/PaymentType&gt; &lt;Url&gt;https://dataapi.justgiving.com/v1/charity/2233/abc132/payments/123456&lt;/Url&gt; &lt;VAT&gt;4.1&lt;/VAT&gt; &lt;/Payment&gt; &lt;Payment&gt; &lt;Account&gt;1212121212&lt;/Account&gt; &lt;CardProcessingFee&gt;0&lt;/CardProcessingFee&gt; &lt;Commission&gt;5.2&lt;/Commission&gt; &lt;Gross&gt;105&lt;/Gross&gt; &lt;Net&gt;99.8&lt;/Net&gt; &lt;PaymentDate&gt;2020-09-18T06:42:04.1367999+00:00&lt;/PaymentDate&gt; &lt;PaymentRef&gt;324234&lt;/PaymentRef&gt; &lt;PaymentType&gt;giftaid&lt;/PaymentType&gt; &lt;Url&gt;https://dataapi.justgiving.com/v1/charity/2233/abc132/payments/123456&lt;/Url&gt; &lt;VAT&gt;4.1&lt;/VAT&gt; &lt;/Payment&gt; &lt;Payment&gt; &lt;Account&gt;1212121212&lt;/Account&gt; &lt;CardProcessingFee&gt;0&lt;/CardProcessingFee&gt; &lt;Commission&gt;5.2&lt;/Commission&gt; &lt;Gross&gt;105&lt;/Gross&gt; &lt;Net&gt;99.8&lt;/Net&gt; &lt;PaymentDate&gt;2020-09-18T06:42:04.1367999+00:00&lt;/PaymentDate&gt; &lt;PaymentRef&gt;324234&lt;/PaymentRef&gt; &lt;PaymentType&gt;giftaid&lt;/PaymentType&gt; &lt;Url&gt;https://dataapi.justgiving.com/v1/charity/2233/abc132/payments/123456&lt;/Url&gt; &lt;VAT&gt;4.1&lt;/VAT&gt; &lt;/Payment&gt; &lt;/ArrayOfPayment&gt;</pre> </div> <ul> <li style="padding-bottom: 5px;"> <span class="name">Item.PaymentRef</span> (<span class="type">Integer (32bit)</span>) <br/><span class="description"> The payment reference. </span><br /> </li> <li style="padding-bottom: 5px;"> <span class="name">Item.PaymentDate</span> (<span class="type">DateTime</span>) <br/><span class="description"> The date of the payment. </span><br /> </li> <li style="padding-bottom: 5px;"> <span class="name">Item.Account</span> (<span class="type">String</span>) <br/><span class="description"> The account the payment was made to. </span><br /> </li> <li style="padding-bottom: 5px;"> <span class="name">Item.Url</span> (<span class="type">String</span>) <br/><span class="description"> The API URL of the details of the payment </span><br /> </li> <li style="padding-bottom: 5px;"> <span class="name">Item.PaymentType</span> (<span class="type">PaymentType</span>) <br/><span class="description"> The type (donation = 0 or Gift Aid = 1) of the payment. Supported values: donation, giftaid</span><br /> </li> <li style="padding-bottom: 5px;"> <span class="name">Item.Gross</span> (<span class="type">Double</span>) <br/><span class="description"> Gross payment amount. </span><br /> </li> <li style="padding-bottom: 5px;"> <span class="name">Item.Commission</span> (<span class="type">Double</span>) <br/><span class="description"> Commission fee. </span><br /> </li> <li style="padding-bottom: 5px;"> <span class="name">Item.CardProcessingFee</span> (<span class="type">Double</span>) <br/><span class="description"> Card processing fee. </span><br /> </li> <li style="padding-bottom: 5px;"> <span class="name">Item.VAT</span> (<span class="type">Double</span>) <br/><span class="description"> VAT. </span><br /> </li> <li style="padding-bottom: 5px;"> <span class="name">Item.Net</span> (<span class="type">Double</span>) <br/><span class="description"> Net payment amount. </span><br /> </li> </ul> </div> </div> </div> </div> <div> </div> </div> <div style="clear: both;"></div> </div> </div> <script type="text/javascript"> SyntaxHighlighter.autoloader( 'js jscript javascript /content/syntaxhighlighter_3.0.83/scripts/shBrushJScript.js', 'xml /content/syntaxhighlighter_3.0.83/scripts/shBrushXml.js'); SyntaxHighlighter.all(); </script> </body> </html>