FrontStream Docs
FrontStream Payments
FrontStream Payments
  • Introducing our Embedded Form
    • Overview and Features
    • Payment Methods process
    • How to implement
    • Compare Embedded Form and Direct API integration
  • Welcome to our Payment API
    • Overview
    • Quick Start
    • API references
      • Search for a Charity for your Donation
      • Make a Payment
      • Learn how to cover Fees
      • Test Payment API Features
        • CharitySearch
        • Payment
        • Fee
      • Temp - Make a Payment - API specification
      • Temp - Charity Search API specification
      • Payment - Specification
      • Calculate Fees - Specification
    • Specification
    • CharitySearch - Specification
Powered by GitBook
On this page
Export as PDF
  1. Welcome to our Payment API
  2. API references

Search for a Charity for your Donation

Payment API - CharitySearch - API specification provides searching for nonprofit charity organizations you would like to make a donation to.

API Overview:

  • API Version: v1

  • Endpoint: /api/CharitySearch

  • Method: GET

This endpoint supports a GET request for searching nonprofit charities with various filters.

Parameters:

  1. Name (optional): Partial or full name of the charity (max 70 characters).

  2. EIN (optional): Valid US/CA Nonprofit EIN or Tax ID (9–15 characters).

  3. CharitySource (optional): Specifies whether the charity is from the US (1) or Canada (2).

  4. City (optional): City name associated with the charity's address (max 30 characters).

  5. State (optional): State code (ISO standard 2-letter code).

  6. PageIndex (optional): Page number for paginated results (default is 1).

  7. PageSize (optional): Number of results per page (default is 10).

  8. SortColumn (optional): Column by which to sort the results (default is NpoName).

  9. SortDesc (optional): Boolean to specify whether to sort in descending order.

Responses:

  • 200 OK: Returns charity search data in JSON format with details like total results, pagination, and charity records.

  • 400 Bad Request: If the request has errors, it returns a list of broken rules.

  • 404 Not Found: If no charity records match the search criteria, a detailed problem message is returned.

Data Models:

  1. CharitySearchResults: Contains total result count, total pages, and a list of charity records.

  2. CharitySearchResultsList: Includes details for each charity, such as:

    • CharityId: Unique identifier

    • NpoName: Charity name

    • EIN: Tax ID

    • Address: Charity's address

    • NpoEligibilityFlag: Indicates tax-deductible donation eligibility

    • ParentOrgName: Parent charity (if applicable)

    • NTEEcode: IRS classification code for US charities

  3. BrokenRule: Describes errors in the request with an error code and message.

  4. ProblemDetails: Provides detailed error messages if the data is not found or there is an issue.

Try out our Charity Search API

This API is useful for searching charity organizations by various criteria and retrieving detailed records.

PreviousAPI referencesNextMake a Payment

Last updated 4 months ago

CharitySearch
Page cover image