Overview

Payment API summary

Our FrontStream Payment API provides various endpoints to handle payment-related functionalities and provides comprehensive tools for handling transactions, fees, charity-related data, and reporting. Enabling seamless integration into payment processing systems and other related platforms. Below is an overview of the key features and functionality supported by this API:

Authentication & Access Control:

Our Endpoints require an AccessToken to authenticate API requests and this token is provided after successful authentication through the /api/ClientSession endpoint.

1. ClientSession (POST /api/ClientSession)

• Purpose: This endpoint is used to authenticate an application and generate an API AccessToken.

• Responses:

  • 200 OK: Successful authentication, returns an AccessToken.

  • 400 Bad Request: Authentication failure.

• Request: The request body contains FrontStream assigned Client Specific data.

Finding your favorite Charity

2. Charity Search (GET /api/CharitySearch)

• Purpose: Allows searching for nonprofit charities based on various optional filters such as name, EIN, city, and state.

• Parameters: Parameters include charity name, EIN, charity source, city, state, pagination options like PageIndex and PageSize, and sorting options.

• Responses:

  • 200 OK: Returns search results for charities.

  • 400 Bad Request: If the search request is malformed.

  • 404 Not Found: If no matching charities are found.

Making a Payment

3. Make Payment (POST /api/payment)

• Purpose: Initiates a payment transaction.

• Parameters: Requires an AccessToken and includes optional and required body parameters for successful transactions.

• Responses:

  • 201 Created: Returns the details of the created payment.

  • 400 Bad Request: If the payment creation fails.

Help cover Fees

4. Fees Calculation (GET /api/fee)

• Purpose: Calculates various fees based on transaction details, including transaction amount, source grouping, and other parameters like charity ID, organization GUID, card type, etc.

• Parameters: Includes optional and required parameters like Amount, TransactionSourceGroupId, PayFee, etc.

• Responses:

  • 200 OK: Returns calculated fee details.

  • 400 Bad Request: If fee calculation fails.

  • 404 Not Found: If fees are not found.

• Details: Detailed breakdown of fees such as card fees, commission rates, partner overrides, etc.

Transaction Reporting

5. Generate Payments Report (POST /api/generatePaymentsReport)

• Purpose: Generates a report on payments, filtered by various criteria.

• Parameters: Requires an AccessToken and a request body containing the report filters.

• Responses:

  • 200 OK: Returns the generated payments report.

  • 400 Bad Request: If report generation fails.

And get Webhook Notifications

6. Notification Test (POST /api/notificationTest)

• Purpose: Sends a test notification to an integration source API, useful for testing notification payloads.

• Parameters: Requires url (endpoint) and payload (notification data).

• Responses:

  • 200 OK: Successfully sent the notification.

  • 400 Bad Request: If the notification fails.

API Structure:

• The API is designed with a set of resources organized by functional groups (e.g., Authentication, Charity Search, Payments, Fees, Reports, and Notification).

• It supports various HTTP methods like GET, POST, and utilizes JSON for data exchange.

The FronstSteam Payment API offers a complete set of tools for managing transactions, fees, charity data, and reporting, allowing for smooth integration with payment processing systems and other related platforms. Take the next step into our Quick Start guide.