Congratulations on installing PosiPay! After your initial installation, you are now able to configure the features to make them accessible.
Note: Do this after installing the latest package.
When installing PosiPay using a YML script, you'll find that certain configurations are handled automatically, streamlining the setup process. However, there are additional configurations that require your manual input to ensure everything functions correctly. For those specific manual configuration steps, please see the link provided below for comprehensive instructions.
If you choose not to utilize the YML script for your configuration, please follow the detailed steps outlined below to successfully complete the setup process.
Grant Access to PosiPay
To have access to the PosiPay features, assign PosiPay’s Permission Set to a User with a System Administrator profile.
...
Choose PosiPay and click Add to Enabled Permissions Sets then click Save. The System Administrator now has access to all of the PosiPay objects and fields.
Enable Guest Access
For Stripe to be able to engage with PosiPay, we need to create the right environment that allows Stripe to speak to certain objects within PosiPay.
Enable Communities
Enable the Experience Cloud communities.
Setup > Digital Experiences > Settings > tick Enable Digital Experiences > click Save
...
Create Community Site
Create a site for Webhook
Go to Setup > All Sites > Click New
...
Choose a template, for our Site, we > choose Build Your Own (Aura) .
...
Fill in the necessary information then click Create.
For example:
...
After doing so, click Builder.
...
Display the Stripe Form component.> click Builder
Fill out the following fields below:
Required Fields
Gateway Account = Gateway ID
Payment Method = Credit Card; Direct Debit
Require CVC = TRUE
...
Click the Publish button in the upper right corner and it will show a confirmation message and click Publish.
...
After creating the Community Sites do the following configuration:
Go to Setup > Home page
In the Quick Find box search All Sites and click Builder
...
The Community page should be accessible by Guest User
...
Name and URL
Name = Webhook
URL = webhook
Publish the site by clicking the Publish button.
Set the site to Public Access.
...
Webhook Guest User Profile Config
Enable Webhook Listener
In the next step, we will set up the webhooks from Stripe’s end, but first, you need to make sure you are configured to be able to listen to them correctly.
...
Enabled these Apex Classes
PosiPay.CommonFunction
PosiPay.StripeFormComponentController
PosiPay.WebhookListener
...
Webhook Object Access
Go to Setup > Click All Sites
...
Search for the Objects that you want to configure for the Guest User.
...
Gateway Event
Click Edit and tick Read and Create under the Object Permissions as well as in Fields Permissions and click Save.
Gateway Account
PosiPay Log
Set up the Smart Retries on a Stripe account
There are various reasons why payments may fail, but many of them are fixable. If you are using Stripe Billing you can use Stripe to automatically retry failed payments by configuring the settings in the Retries tab of the Revenue Recovery Dashboard.
Open your Stripe Account and then locate and click on the “Revenue Recovery” option in the navigation menu.
...
In the Revenue recovery Dashboard navigate to the Retries tab, and in the Card payment retries select Use a Smart Retry policy for subscriptions (note that you don’t need to use subscriptions to access Smart Retries on Invoices).
Sharing Settings
...
Gateway Invoice
...
Create a Community Site for Stripe Form
Go to Setup > All Sites > Click New
...
Choose a template, for our Site, we choose Build Your Own (Aura).
...
Fill in the necessary information then click Create.
...
After doing so, click Builder.
...
Display the Stripe Form component.
Fill out the following fields below:
Required Fields
Gateway Account = Gateway ID
Payment Method = Credit Card; Direct Debit
Require CVC = TRUE
...
Click the Publish button in the upper right corner and it will show a confirmation message and click Publish.
...
After creating the Community Sites do the following configuration:
Go to Setup > Home page
In the Quick Find box search All Sites and click Builder
...
The Community page should be accessible by Guest User
...
Manually Displaying Fields in Page Layout
Some fields need to be manually displayed in the page layout for some objects.
To display these fields follow this step:
Go to Set Up > Object Manager > search for the Object > Page Layout > click the specific layout > Drag and drop the fields to their corresponding areas > Save
Bank Account
Display the following fields in the page layout.
Active
Bank Account Number
Bank Code
...
Bank Deposit Batch
Display the following fields in the page layout.
Bank Account
Batch Status
Status Message
When Generated
Bank Reconciliation Status
Bank Statement Line
Settlement Date
...
Display the Generate Bank Slip, go to Page Layout > Mobile & Lightning Actions
...
Contact
Display the following field in the page layout.
Default Gateway Customer
...
Gateway Account
Display the following fields in the page layout.
API Token
Accepted Card
Accepted Currency
Active
Base URL
Default Currency
Description
Enable 3D Secure
Enable Live Payments from Sandbox
Faud Trigger
Gateway Provider
Payment Method
Publishable Key
Sandbox
Version
Webhook Endpoint URL
...
Display the Authenticate, go to Page Layout > Mobile & Lightning Actions
...
Gateway Customer
Display the following fields in the page layout.
Customer Address
Customer Email
Customer ID
Customer Phone
Customer
Default Payment Source
Gateway Account
...
Gateway Event
Display the following fields in the page layout.
Event ID
Event Status
Gateway Account
Raw Request
Webhook Event Object
...
Gateway Invoice
Display the following fields in the page layout.
Amount Paid
Attempt Count
Gateway Event
Invoice Date
Invoice ID
Invoice Status
Payment Intent ID
...
Gateway Transaction
Display the following fields in the page layout.
Adjustment Date
Adjustment ID
Amount
Balance Transaction
Charge ID
Decline Code
Flagged As Fraud
Gateway Account
Gateway Event
Gateway Fee
Gateway Invoice
Order
Payment Date
Payment Intent Id
Payment Method
Process Type
Refund Date
Refund Id
Result Code
Result Message
Risk Level
Risk Score
Settlement
Source Transaction
Transaction Currency
Transaction Reference ID
Transaction Status
...
Add the following Picklist Value in the Transaction Status field.
Canceled
Dispute Under Review
...
Display the Refund Payment, go to Page Layout > Mobile & Lightning Actions
...
Order
Add new picklist value in Status
Go to Set up > Object Manager > Order > Fields & Relationship > Status > Click New in Order Status Picklist Values
Add a new picklist value called “Paid” where the Status Category is “Activated”
Add a new picklist value called “Failed” where the Status Category is “Draft”
Display the following fields in the page layout.
Check Date
Check Drawer
Payment Identifier
Payment Method
Receiving Bank Account
Status
Bank Reconciliation Status
Bank Statement Line
Settlement Date
...
Payment Source
Display the following fields in the Payment Source page layout.
Account Holder Name
Active
BSB Number
Card Expiry Date
Card Type
Cardholder Name
Default Payment Source
Gateway Account
Gateway Customer
Last4 Digit
Payer
Payment Source Type
Token
...
PosiPay Log
Display the following fields in the page layout.
Description
Details
Source
Type
...
Gateway Settlement
Display the following fields in the page layout.
Amount
Error Code
Error Message
Gateway Account
Gateway Adjustment Total
Gateway Fee Total
Gateway Reconciliation Status
Gateway Reference ID
Gateway Refund Total
Reconciliation Balance
Reconciliation Date
Starting After
Stripe Fee Total
Bank Reconciliation Status
Bank Statement Line
Receiving Bank Account
Settlement Date
...
Bank Statement
Display the following fields in the page layout.
Bank Account
Bank Statement Name
Date Reconciled
Status
...
Bank Statement Line
Display the following fields in the page layout.
Amount
Bank Statement
Bank Statement Line Name
Description
Reconciliation Status
Settlement Date
Transaction Reference
Transaction Type
...
Global Picklist
Payment Method
The only picklists are the following; otherwise, please remove them.
Credit Card
BECS Debit
Cash
Check
Direct Deposit
Go to Set up > Search for Picklist Value Set > Payment Method
...
Sharing Settings
Enabling the guest user (the same guest user that has been set up in the Community site) to obtain access to the Gateway Account and Gateway Events records.
Go to Set up
In the Quick Find box, search for Sharing Settings
...
...
Under the Sharing Rule section, look for Gateway Account Sharing Rules and
...
Gateway Event Sharing Rules,
...
then click New.
...
Gateway Account and Gateway Event Sharing Rule
Note: The same process will be set up in the Gateway Account and the Gateway Event.
Step 1: Rule Name
...
Step 3: Select which records to be shared
Field: Owner ID
Operator: equalsnot equal to
Value: Guest User ID
...
Step 4: Select the users to share with
...
Access Level: Read Only
...
Click Save.
Change Data Capture
Go to Set Up and search for Data Capture.
In the Change Data Capture search for Gateway Transaction (PosiPay__GatewayTransaction__c) and Bank Statement Line (PosiPay__BankStatementLine__c) . Add it as Selected Entities then click Save.
...
Manual Configuration for YML Script
If PosiPay is installed via a YML script, some configurations are automatically completed; however, others need to be set up manually. Please follow the configuration steps below.
Translation Workbench
This configuration is optional. If you wish to translate some field names or labels, follow this step.
Enable Translation Workbench
Make sure that the Translation Workbench is enabled, if it is currently disabled enable it. To enable,
Go to Set up > Search Translation Workbench in the quick find box > Translation Language Settings
...
Add Translated Languages and Translator
Click Add to select the languages your organization supports and the users who are responsible for translating that language.
...
To make users translators for this language, select them from the Available List and click add. Make sure you give all translators the "View Setup and Configuration" permission so that they can begin translating.
...
Select Language in your Org
Go to Set up > Language Settings > Enable platform-only languages - no default translations are provided for platform-only languages check box is ticked.
Then you can add languages that your org supports. Click Save after.
...
PosiPay STF File
To import the PosiPay STF (Salesforce Translation File), your org must be using PosiPay package version 1.5.
Before proceeding with the import, manually update the flow versions in the STF file to the current version.
| View file | ||
|---|---|---|
|
For orgs using a PosiPay package version below 1.5, please use the STF file provided below
| View file | ||
|---|---|---|
|
Export STF File
Note: Do this step if you (the translator) don’t have an STF file; otherwise, if you do, then skip this step.
If you are a translator or if you don’t have a STF file yet for importing. You can export it and translate the words that are translatable for your org’s supported language.
...
(If User is a translator) You can now then remove those rows that are not included in your translation. It should look something like the image below (Take note that it only defers on the how many translated content that the translator has translated).
...
Importing the STF File
If the user has already the STF file, the user can just , go to Setup>Translation Workbench>Import Click the Choose File button then select your STF file. After selecting you can now then press Import.
...