Parlour

Across our entities, properties, endpoints, and webhooks we have tried our best to name things as specific as possible to avoid confusion. However you may afterall find the following parlour helpful.

Understanding agents

The agents you will get to know are:

Agent

Description

Agent

Description

Merchant

The organisation or company using OnlineFundraising.

Payment Gateway

The Payment Gateway providing Payment Services accessed by OnlineFundraising.

Contact

The Payee and/or End User.

User

The User of OnlineFundraising with optionally different access levels.

System

OnlineFundraising's automatic Payment Solution.

Understanding entities

The main entities are:

Entity

Description

Entity

Description

Contact

The Payee and/or End User.

Agreement

Defines what is being paid, how often, from when, and how much.

Payment Method

Defines how payments are charged.

Subscription

The connection between Agreement, Payment Method, and Contact representing the Contact's engagement of the Agreement.

Payment

Describes the individual Payment (single, one-off and recurring).



The relation between the main entities can be described with this diagram:

FYI

For old timers you may find an entity missing in the diagram above. We have chosen to deprecate a "Project" entity, which contained various informations on the type of Agreement and Payments, in favor of the following split responsibility:

Deprecated project property

API handling

Deprecated project property

API handling

Donation purpose

Metadata stored on the related DataSet.

Tax deductibility

The Agreement property: "taxDeductable".

Fixation of amount

The Agreement property: "amount" accompanied by properties for quantity and VAT.

Accounting Code

The Agreement property: "purposeAccountingCode" accompanied by the Payment property: "paymentMethodAccountingCode" which combined will help accounting keep track of transactions across purposes and payment methods.