API Documentation

Query Transactions

Use the following endpoint to query transactions:

GET https://api.donationpay.org/v1.0/transactions/

Query Parameters:

• start_date (optional): Start date of the date range to filter transactions
• end_date (optional): End date of the date range to filter transactions
• email (optional): Email address to filter transactions
• min_amount (optional): Minimum amount of transactions to filter
• max_amount (optional): Maximum amount of transactions to filter
• donor_full_name (optional): Full name of the donor to filter transactions
• donor_last_name (optional): Last name of the donor to filter transactions

Example Request:

GET https://api.donationpay.org/v1.0/transactions/?start_date=2023-01-01&end_date=2023-06-30&email=john@example.com

Example Response:

{
        "data": [
          {
            "id": "abc12345",
            "date": "2023-05-15",
            "request_uri": "/donate",
            "email_address": "john@example.com",
            "transaction_status": "Completed",
            "transaction_amount": 100.0,
            "refund_amount": 0.0,
            "refund_date": null,
            "billing_full_name": "John Doe",
            "billing_name_first": "John",
            "billing_name_last": "Doe",
            "billing_address": "123 Main St",
            "billing_city": "San Francisco",
            "billing_state": "CA",
            "billing_zip_code": "94110",
            "billing_country": "US",
            "custom_fields": [JSON]{
              "field_1": "Custom Value 1",
              "field_2": "Custom Value 2"
            }
          },
          {
            "id": "def67890",
            "date": "2023-04-20",
            "request_uri": "/give",
            "email_address": "jane@example.com",
            "transaction_status": "Refunded",
            "transaction_amount": 50.0,
            "refund_amount": 50.0,
            "refund_date": "2023-04-21",
            "billing_full_name": "Jane Smith",
            "billing_name_first": "Jane",
            "billing_name_last": "Smith",
            "billing_address": "456 Oak St",
            "billing_city": "Berkeley",
            "billing_state": "CA",
            "billing_zip_code": "94707",
            "billing_country": "US",
            "custom_fields": [JSON]{
              "field_1": "Custom Value A",
              "field_2": "Custom Value B"
            }
          }
        ]
      }

Code Examples

• cURL
• PHP
• Ruby
• Python
• Java

curl -X GET -H "X-API-Key: {your-api-key}" https://api.donationpay.org/v1.0/transactions/

<?php
            $url = "https://api.donationpay.org/v1.0/transactions/";

            $options = array(
                'http' => array(
                    'header' => "X-API-Key: {your-api-key}",
                    'method' => 'GET'
                )
            );

            $context = stream_context_create($options);
            $response = file_get_contents($url, false, $context);

            if ($response === false) {
                // Handle error
            } else {
                $data = json_decode($response, true);
                // Handle response
            }
            ?>

require 'net/http'
            require 'json'

            url = URI.parse('https://api.donationpay.org/v1.0/transactions/')
            req = Net::HTTP::Get.new(url.path)
            req['X-API-Key'] = '{your-api-key}'

            res = Net::HTTP.start(url.host, url.port) do |http|
              http.request(req)
            end

            if res.is_a?(Net::HTTPSuccess)
              data = JSON.parse(res.body)
              # Handle response
            else
              # Handle error
            end

import requests

            url = 'https://api.donationpay.org/v1.0/transactions/'
            headers = {
                'X-API-Key': '{your-api-key}'
            }

            response = requests.get(url, headers=headers)

            if response.status_code == 200:
                data = response.json()
                # Handle response
            else:
                # Handle error

import java.net.HttpURLConnection;
            import java.net.URL;
            import java.io.BufferedReader;
            import java.io.InputStreamReader;

            public class APIClient {
                public static void main(String[] args) {
                    try {
                        URL url = new URL("https://api.donationpay.org/v1.0/transactions/");
                        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
                        connection.setRequestMethod("GET");
                        connection.setRequestProperty("X-API-Key", "{your-api-key}");

                        int responseCode = connection.getResponseCode();

                        if (responseCode == HttpURLConnection.HTTP_OK) {
                            BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
                            String inputLine;
                            StringBuilder response = new StringBuilder();

                            while ((inputLine = in.readLine()) != null) {
                                response.append(inputLine);
                            }
                            in.close();

                            String responseData = response.toString();
                            // Handle response
                        } else {
                            // Handle error
                        }
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            }

Payment Pages

Use the following endpoints to retrieve a list of payment pages or details of a specific payment page:

Endpoints:

• List All Payment Pages

  GET https://api.donationpay.org/v1.0/pages/

• Get a Specific Payment Page

  GET https://api.donationpay.org/v1.0/pages/{page_id}

Headers:

Query Parameters (Optional):

Example Requests:

1. List All Payment Pages

GET https://api.donationpay.org/v1.0/pages/

2. Get a Specific Payment Page

GET https://api.donationpay.org/v1.0/pages/abcd1234

Example Responses:

1. List All Payment Pages

{
        "data": [
            {
                "id": "abcd1234",
                "name": "Donation Page 1",
                "path": "donation-page-1",
                "title": "Support Our Cause",
                "created": "2024-11-01T12:00:00Z",
                "active": true
            },
            {
                "id": "efgh5678",
                "name": "Donation Page 2",
                "path": "donation-page-2",
                "title": "Help the Community",
                "created": "2024-11-05T14:30:00Z",
                "active": true
            }
        ]
    }

2. Get a Specific Payment Page

{
        "data": {
            "id": "abcd1234",
            "name": "Donation Page 1",
            "path": "donation-page-1",
            "title": "Support Our Cause",
            "active": true,
            "template_settings": {
                // Template-specific configurations
            },
            "minimum_amount": 10.00,
            "giving_option_settings": {
                // Settings for giving options
            },
            "amount_options": [
                {
                    "label": "$25",
                    "value": 25
                },
                {
                    "label": "$50",
                    "value": 50
                }
            ],
            "custom_fields": [
                {
                    "field_name": "Your Name",
                    "field_type": "text"
                },
                {
                    "field_name": "Your Message",
                    "field_type": "textarea"
                }
            ],
            "text_above_form": "
Thank you for considering a donation!
",
            "text_below_form": "
Your support means the world to us.
",
            "cc_submit_text": "Donate with Credit Card",
            "ach_submit_text": "Donate via ACH",
            "headline": "Make a Difference Today",
            "receipt_settings": {
                // Receipt-related settings
            },
            "donor_info_settings": {
                "phone": true,
                "email": true
            },
            "multiple_amount_selector_settings": {
                // Settings for amount selectors
            },
            "upsell_settings": {
                // Upsell configurations
            }
        }
    }

Error Responses:

1. Invalid API Key

{
        "error": "Invalid API key"
    }

2. Page Not Found

{
        "error": "Payment page not found"
    }

3. Invalid Endpoint

{
        "error": "Invalid endpoint"
    }

4. Method Not Allowed

{
        "error": "Method not allowed"
    }

Field Descriptions: