Payments2Us ManualsPayments2Us User Manual OtherWhat is data model and how are the objects are used

What is data model and how are the objects are used

The data model shown below is designed to give a high level overview.

1. Data model

2. Objects

Untitled Document

Object

Notes

Merchant Facility [AAkPay__Payment_Setting__c]

The merchant account object contains details on a particular facility. AAkonsult Payment customers need to arrange with their bank a Merchant Facility that works with Direct Payment Solutions (DPS).

Most organisations would just have one merchant facility, but some organisations need to have multiples as they may have donation payments go into one bank account and then training, supplies etc. into another bank account.

Payment Forms [AAkPay__Payment_Type__c

For each form on the website, a new Payment Form is setup. You may have one Payment Form for say training payments, another for memberships and another for donations.

Payment Forms provides a number of configurable options that will drive the options and behaviour of what appears on the web payment form.

Sidebar Widgets

Sidebar widgets contain sections on the checkout form that appear to the right hand side. The widgets are details such as progress bar, campaign progess guage, team members, recent donations etc.

Sidebar Widgets are added from the Payment Form maintenance screen.

Payment Options

Payment Options represent products or services. They could be used for example for a memberships and have values such as Family, Concessions, Single, Corporate etc.

In addition, Payment Forms could be used for subscriptions. Eg. A magazine publication with say 3 month subscription, 1 year and 2 years.

For Payment Forms that have payment options, any payments that are processed for this Payment Form, a subscription and subscription payment record will be created for the contact as part of the matching process.

Payment Txn

 

The Payment Transaction file stores all payments, including credit cards, manual payments, refunds and card authorisation.

This object should be in read only view for most users as it is created as a result of one of the transactions types.

Record types are used to differentiate the transaction types. For Credit Card payments, refunds can be created from a button on the Payment Transaction detail screen.

Payment Items

This stores details about the payment transaction line items. The type of data stored, depends on the transaction type. There are three record types used to differentiate the item items:

  1. Shopping Cart. This contains details of items purchased through the shopping cart integration.
  2. Event. Contains details of the tickets and persons that have registered for the event.
  3. Subscriber. Contains the persons that make up the subscriber group (Eg. Family Members).

Payment Item Group

Used with the Events functionality to group payment items by ticket type.
For example, the payment items may have 3 entries for 3 different contacts. This may be two ticket types of “Member” with 2 people and “Non Member” with one person. There would be two payment groups in the above example for “Members” and “Non Members”

Recurring Payments

For credit card payments that have a “regular payment frequency” that is NOT one-off then a recurring entry will be created.

A Direct Payment Solution billing token is stored on the recurring payments record. This allows for recurring billings to be made without the need to store credit card details.

Recurring Payment Txn

Links all payments with the recurring payment enabling roll up summaries, such as total paid, total donated etc.

Direct Debit Batch

Creates a unique batch to link all transactions that are to be processed as part of the Direct Debit Extract/Upload/Process

Direct Debit Payment Item

Is a child object of the "Direct Debit Batch" object and links to the "Payment Txn". Enables roll up summaries to be added between Direct Debit Batch and Payment Txn

Subscriber Group

Subscriber Groups are similar to the “household” concept where groups of members, for example Family Members are grouped together.

Subscriptions

Subscriptions are created as a result of a payment that has a payment option. Subscriptions could be for membership, or for magazine publications.

Subscription payments

For subscriptions that are renewed, a new subscription payment record is created.

If the “subscription” was memberships that lasted annually, the “subscription payment” would have a record for each year the payee renewed their membership.

Account Subscriptions

Account level subscriptions are created as a result of a payment that has a payment option. Subscriptions could be for membership, or for magazine publications.

The Payment Option Subscription Level must be set as “Account” to have account level subscriptions.

Account Subscription payments

For Account subscriptions that are renewed, a new subscription payment record is created.

If the “Account Subscription” was memberships that lasted annually, the “subscription payment” would have a record for each year the payee renewed their membership.

The Payment Option Subscription Level must be set as “Account” to have account level subscriptions.

Subscription Issue

Subscriptions issues are used for magazine/publication type of subscriptions. For this, the subscription term is driven more from the “issue” number, vs. other types of subscriptions that work off the length (e.g. months) of the contract.

Subscription Issue Item

For subscriptions that are used for magazine/publication type of subscriptions, a subscription Issue item is generated when the “Mailout Generation” button is pressed on the Subscription Issue object.
The Subscription Issue object is used for reporting of those subscribers that are due to get this particular issue of the subscription. The report can be set to the mail house for names/address details for who the magazines/publications should be mailed to.

Fundraiser ID

Stores the Fundraiser ID and the source of the Fundraiser ID for this contact. If the Contact Fundraiser ID source or Fundraiser ID number are changed on the Contact, then this object is automatically updated. Fundraiser IDs are used as part of the matching process for Import Files. A Contact's Fundraiser ID is their reference number as provided in 3rd party fundraising platforms such as Everyday Hero, Give Now, GoFundraise etc.

Change Schedule Template

Change schedule template allows for a list standard list of change schedules to be defined. These can be linked to a membership/subscription type and automatically applied on memberships/subscription creation

Change Schedule

Sets up a change that can be scheduled as a once off change, ongoing change, recurring/regular change or a change in a specified number of days. These changes are can be applied to Subscriptions, Account Subscriptions and/or Recurring Payments

Change Schedule Log

Every time a change is enacted, the change is written to the Change Schedule Log to provide an audit trail of exactly when the change occurred.

URL Tokens

Used to generate a unique reference and to default options and behaviour for the online payment and manual payment forms.

For Account Subscription and Subscription records, a URL Token is automatically generated for each record created. This is so that it can be used in emails for renewal payments.

Import File

Used to upload CSV files for processing. Once imported, the Import File Line Items will be created

Import File Line Items

Contains a line for each row in the Imported file CSV

Import File Line Item Payment Txn

When an Import file is processed, the Import File line items are allocated open Payment Txn records

Import File Mapping

Contains a record for saved filed mappings. Is linked to the import file "Import Type" picklist field

Import File Mapping Field

Is a child of Import File Mapping. Contains from/to column mapping of CSV headers to Salesforce Field Names

Import File Translation Code

Is used during the import file upload process. If a translation code is mapped to a field value, the import fields value is translated from/to using the related Import File Translation Code Item. An example value for this object could be "Country"

Import File Translation Code Item

Is a child of Import File Translation Code. Contains from/to value transforming. For example "AU" in from could be mapped to "Australia"

Peer-to-Peer Campaign This object is primarily used for the initial setup and registration of Peer-to-Peer entrants. Once the batch processor has processed the registration, a sub Campaign is created for the registration and that is used from then on.
Team Members The Team Member object stores a list of Team Members for Peer-to-Peer fundraising. If the Peer-to-Peer fundraising page is for an individual then a single member is created.
Team Member Payement Txns This object is used to link the Payment Txn's with the Team Members. This enable rollups of total payments allocated for each individual team member.
Batch Entry The Batch Entry Object is used to details on the batch header. The batch header contains hash totals such as the total amount of all line items, the total number of records etc. It also contains a status to indicate where the batch processing is upto
Batch Entry Line Batch Entry lines are related to the batch. Each Batch Line is linked to a Payment Txn record. The Batch Line is used to provide roll up summary counts for the Batch Entry Object

IP Address Access [AAkPay__Whitelist__c

Stores IP Addresses of external organisations addresses. Blocked: will stop these people from using the online payment forms. Allowed: This is useful for organisations that use external organisations to enter donations/payments online and this means their IP address will not be blocked.