Integration Reference Documentation and API Access
      Back to home
      1. Partnerships and Integrations | Double the Donation
      2. Integration Reference Documentation and API Access

      Double the Donation Data Schema

      This article provides information about Double the Donation's data schema.

      Donation Data Schema

      Provision Account Data Schema

      Billing Plans

      Donation Data Schema

      1. 360matchpro_public_key (required): The public API key associated with the 360MatchPro account. This is not the same as the partner public API key. (string, 16 characters)

      2. partner_identifier (required): Unique for each Double the Donation partner platform. This will be the same value for every transaction that comes from a single partner platform. This partner identifier is securely provided to integration partners by the Double the Donation Partnerships Team and is NOT the same as their partner API key.

      3. campaign (required): Campaigns are arbitrary, plain text containers used to group donations. You can add all donations into one campaign, or break them out into separate campaigns. Some sample campaigns would be: "FY2016-Fall", "Boston Walkathahon", "EOY_Giving", etc. (string)

      4. donation_identifier (required): A unique identifier generated by your platform, used to tie entries together between 360MatchPro and your platform. It can contain spaces and special characters. (string)

      5. donor_email (strongly recommended): The email address associated with the donation. (string)

      6. donor_first_name (strongly recommended): First name of the donor. (string)

      7. donor_last_name (strongly recommended): Last name of the donor. (string)

      8. donation_amount (strongly recommended): An integer or decimal value describing the dollar amount of the donation. (number)

      9. donation_datetime (optional): Date and time of the donation expressed according to ISO 8601. If a timestamp is not provided, the current date and time will be assigned to the donation. While this field is generally omitted for online transactions, it is particularly useful for uploading donations that aren't real-time (e.g., offline donations). (string)

      10. donor_address (optional): A JSON object that contains the donor's address. The donor_address field is not required. If it is provided, all fields except address2 are required. If the requirements aren't met, the donation will be registered but the donor_address will be omitted.

      11. donor_phone (optional): The donor's phone number. No requirements for format. Can contain "(", ")", "-", and other characters. (string)

      12. anonymous (optional): Whether the donation was made anonymously. Pass in "true" if the gift was anonymous. Defaults to "null" if you omit this field. (Boolean)

      13. in_memoriam (optional): Whether the donation was made in memoriam. Pass in "true" if the gift was in memorial. Defaults to "null" if you omit this field. (Boolean)

      14. athletic (optional): Whether the donation was made to the athletic foundation. Most applicable for platforms with educational institutions as clients, as many company matching gift programs will not match gifts to athletic departments, foundations, scholarships, etc. Pass in "true" if the gift is made to an athletic campaign. Defaults to "null" if you omit this field. (Boolean)

      15. recurring (optional): Whether the donation is part of a recurring series of donations. Pass in "true" if this gift is part of a recurring donation. Defaults to "null" if you omit this field. (Boolean)

      16. doublethedonation_company_id (optional): The company ID in the Double the Donation database. Generated by the streamlined search field on the donation form and the matching gift plugin on the confirmation page. (integer)

      17. doublethedonation_entered_text (optional): The actual text that was entered by the user into the streamlined search field on the donation form or the matching gift plugin on the confirmation page. (string)

      Provision Account Data Schema

      1. organization_name (required): The name of the client organization (e.g., "Leukemia & Lymphoma Society"). (string)

      2. email (required): The email address of the primary point of contact at the organization. This email can be used to log into 360MatchPro. (string) 

      3. username (optional): The username for the organization (e.g., "LLS"). This username can be used to log into 360MatchPro. (string)

      4. from_name (optional): The name of the person, department, or organization that automated emails appear to be sent from (e.g., "The LLS Matching Gift Team"). Able to be customized by the organization within 360MatchPro. (string)

      5. from_email (optional): The email address that automated emails appear to be sent from. A domain will be extracted from this field and used to create CNAME records for whitelisting. If unset, automated emails will come from matchinggifts@doublethedonation.com . Able to be customized by the organization within 360MatchPro. (string)

      6. plugin_url (optional): The URL on the organization's website featuring the Double the Donation plugin (e.g., LLS Matching Gift Page). Automated emails will link to this page. If unset, a similar page will be autogenerated. (string)

      7. employer_identification_number (optional): The Employer Identification Number (EIN) of the organization. (string, 9 digits)

       

      NOTE: As of 4/6/2020, the following fields are no longer in use. Existing integrations using these fields to create new client accounts with a variable billing structure will still continue to be supported. Going forward, any client billing will be managed within the Double the Donation system and not determined by fields passed in through the API by partners.

      1. billing_plan_type (required): The billing plan type. Permissible values include: prepaid, variable_identified, and variable_submitted. Reference "Billing Plan" below for additional information. (string) 
      2. prepaid_price (required): The up-front dollar amount the organization will be charged for a prepaid billing plan. This parameter is required only if billing_plan_type is prepaid and will be omitted otherwise. (string) 
      3. plan_type (optional): The 360MatchPro plan type. Permissible values include: enterprise and standard. If unset, enterprise will be the default. (string)

      Billing Plans

      1. prepaid: Each organization is charged a flat yearly fee. The number of donations processed is not metered.

      2. variable_identified: Each organization is charged every month based on donations that are identified as match-eligible. The organization will be asked to input their billing information in the 360MatchPro account portal.

      3. variable_submitted: Each organization is charged every month based on donations that donors mark as having submitted a matching gift request. The organization will be asked to input their billing information in the 360MatchPro account portal.