Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Grant Access to PosiPay

To have access to the PosiPay features, assign PosiPay’s Permission Set to a User with a System Administrator profile.

...

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.

  • 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:

  1. Go to Setup > Home page

  2. In the Quick Find box search All Sites and click Builder

...

  1. The Community page should be accessible by Guest User

...

  • Name and URL

    • Name = Webhook

    • URL = webhook

      image-20240624-233806.pngImage Added
  • Publish the site by clicking the Publish button.

    image-20240925-023045.pngImage Added

  • 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.

    image-20240312-080253.png

    image-20240312-080327.png

  • Gateway Account

    image-20240131-031029.pngimage-20240527-000233.png

  • PosiPay Log

    image-20240131-031121.png
  • Gateway Invoice

...

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.

...

...

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:

...

  • 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:

  1. Go to Setup > Home page

  2. In the Quick Find box search All Sites and click Builder

...

  1. 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 

...

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 

...

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”  

    image-20240529-053325.pngImage Added

  •  Add a new picklist value called “Failed” where the Status Category is “Draft” 

    image-20240529-053407.pngImage Added

Display the following fields in the page layout.

  • Payment Status

  • Check Date 

  • Check Drawer 

  • Payment Identifier 

  • Payment Method 

  • Receiving Bank Account 

  • Status 

...

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 

...

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 to obtain access to the gateway account and gateway events 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 Gateway Account and Gateway Event.

...

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

...

  1. 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.

...

Translation Workbench

Enable Translation Workbench

...

View file
nameposipay_en_AU_translation (1).stf

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.

...