Skip to main content

Financial Institutions

Welcome to the Advanced Scenarios section of our API documentation. This section provides comprehensive guidance on managing various donation scenarios using our API services. Below are the detailed scenarios you can handle:

Scenarios​

  • Single Donation (Standalone): Manage a single, standalone donation.
  • Recurring Donations: Set up and manage recurring donations based on a fixed frequency and amount.
  • Round Up: Round up other transactions, such as those from a credit/debit card or a bank account, to contribute to donations.
  • Saving Account: Donate a portion of a savings account balance.

API Calls​

Each scenario involves three types of API calls:

  • pub/company: These unauthenticated calls are used in situations where authenticated calls are not possible. They do not share sensitive data and are optional.
  • auth/company: Authenticated calls made on behalf of the company, typically executed by the company's backend. These calls transmit information known only to the company, such as confirming a payment. Follow the Company Authentication guide to manage the login process.
  • auth/consumer-user: Authenticated calls made on behalf of the consumer user, usually by the frontend. These calls send consumer user information, such as authorizations for payments requiring security authentication. Companies can obtain authentication tokens for their clients to streamline the login process. Refer to the Consumer User Authentication guide for details.

Definitions​

  • Payment Method: The method used to pay for the donation. Payments can be managed by cents or by the company.
  • Round Up Source: Information about the source (e.g., credit/debit card, bank account) used to retrieve transactions for rounding up.
  • Transaction: The donation transaction.
  • Subscription: A subscription handles scenarios involving recurring donations (recurring donations, round-up, savings account). Multiple donation transactions are automatically created from a subscription.

If you need further assistance or have specific questions, please refer to the detailed documentation for each scenario or contact tech@centsdonations.com.