Payments
Updated 2 days ago
This article outlines the recent enhancement to the Kulturra's Payment Center: the ability to mark Payment Profiles as Inactive. This update includes a new custom field on the Payment Profile object and additional validation rules to support recurring and installment invoice logic. A new Payment Page parameter has also been introduced to control the visibility of saved profiles.
Active/Inactive Payment Profile
New Field on Payment Profile
A new checkbox field called Inactive has been added to the Payment Profile object to allow better control over profile usage.
Field Name: Inactive
Type: Checkbox
Default Value: False (i.e., the profile is active by default)
Validation Rules
1. To maintain data integrity and avoid disruption to billing automation, the system will prevent inactivation of payment profiles that are actively in use.
A payment profile cannot be set to inactive if it is:
Linked to a Recurring Invoice that:
Has Auto-BillPay = true, AND
Is Active = true
Linked to an Installment Invoice that:
Has Auto-BillPay = true, AND
Is not yet paid
Testing Scenarios
For Recurring Invoices:
1. Create a Recurring Invoice with Is Active = true and Auto-BillPay enabled.
2. Attempt to mark the associated Payment Profile as inactive. An error will be triggered, as the profile is currently in use.
For Installment Invoices:
1. Create an unpaid Installment Invoice with Auto-BillPay enabled.
2. Attempt to inactivate the associated Payment Profile. An error will be triggered, as the profile is currently in use.
Behavior of Inactive Profiles
Inactive profiles will not appear on the Payment Page.
If an inactive profile is used in global methods or APIs, an error will be returned.
Users cannot select an inactive profile when configuring Recurring or Installment Invoices.
Validation is triggered immediately after selecting a profile when Auto-BillPay is enabled.
Do Not Display Profiles On Payment Page
A new parameter has been introduced for both Online and Terminal Payment Pages:
Parameter Name: doNotDisplayProfiles
Type: Boolean
When doNotDisplayProfiles = true:
Existing payment profiles will not be shown to the user.
Any new Credit Card or ACH information entered during the session will not be saved to a profile.
Availability: Spring '25