Release 60

Auto Rescue Now Available For Adyen Credit Card/Tokenized Card Smart Payments (DEV-11397)

Aria now implements auto rescue for Credit Card and Tokenized Credit Card pay methods in the event of real-time payment failures; this is available through the Adyen Smart Payments integration. This works when the client parameter Allow Dunning during payment recovery is set to True.

Installment Terms Phase 4: Extended Use Cases (DEV-11504)

As part of Phase 4 of Installment Terms implementation for non-subscription offerings (NSOs), Aria now supports lump sum installment payments, mid-period cancellation of installments, and additional use cases:

• This release of Installment Terms includes support for dunning late fees; a past due installment will be considered as part of dunning fee calculation.
  • For electronic dunning, Aria now excludes the future installment balance from the master plan instance (MPI) balance to calculate the dunning fee via Fee Type: Percentage Fee, which is determined when you create a dunning process. This implementation is only for self-pay MPIs.
  • For Net Terms dunning, Aria now excludes the future installment balance from the MPI balance to calculate the dunning fee via Fee Type: Percentage Fee. This implementation is only for self-pay MPIs.
• The Days Until Due field value on a Payment Term configuration (Finance > Payment Terms > [New Payment Term]) and a Payment Method configuration (Configuration > Payments > Payment Method > [Add a Payment Method]} is now used to calculate the invoicing due date for independent installments. These enhancements were made in the Aria UI as well as the relevant APIs.
• Aria has also introduced additional loops and strings in support of lump sum payments; please contact your Aria representative for more information. Also, if there is a lump sum with a given installment schedule, the lump sum payment will appear first on that schedule. Otherwise, the oldest installment appears first.
• UI Improvements:
  • An existing installment with lump sum now will display lump sum details by persisting the data on the checkbox. In previous releases, it didn’t persist, and created confusion with users if those lump sum details stored or not.
  • Mandatory fields are now shown in red.
  • Previously, the installment due displayed incorrectly when aligned_lump_sum = 0 (lump sum is communicated when invoice is created). This has been resolved.

API-related enhancements for this feature are also presented on this page.

Enhanced Bill Date Reset Support For Reactivated Master Plans (DEV-11543)

This feature adds a new option ("Use the master plan’s next future anniversary date by offsetting with its billing interval") to the client parameter "Automatically Reset Plan Billing Dates on Non-Billable to Billable Account Status Change" (Configuration > Billing > Invoice Settings), allowing you to automatically adjust the billing date for a reactivated plan, even if the plan has been suspended for multiple billing cycles.

You can also select this option for the Reset Billing Dates field in the "Change Plan Status" UI of a Master Plan Instance (Account Overview > Plans > Status link in side panel > Change Plan Status link at the top).

Auto-Renew Contracts With Different Durations (DEV-11544)

This feature enhances Aria's support for contracts by introducing the ability to specify a different contract duration for auto-renewal, when either creating or modifying a contract (e.g., you could specify that a contract auto-renew from a monthly contract to a daily-weekly contract). Key details appear below.

Aria added a new contract-related client parameter, "Prevent multiple active contracts on same plan instance". This setting controls whether you can create multiple active contracts for the same plan instance. When set to "True" (default), you will not be able to create multiple active contracts for the same plan instance, and the system will return the error, "16034—Multiple active contracts on the same Plan Instance are not allowed," if you attempt to do so.

You can now choose as a Contract End Action "Renew existing contract automatically with different duration" when creating or modifying either a Multi-Plan or Universal contract in the Aria UI. This option is available under Contract End Action on the screen Account Overview > Plans > Contracts tab > Create a New Contract, after you select Multi-Plan or Universal.

When selected, additional choices appear allowing you to specify an end date or specify a numeric duration and duration type (days, weeks, or months).

Aria introduces two new email template classes to support this feature:

• Contract Renewal (ARAD): Automatically renew with a different duration.
• Contract End (CERD): Notify account holders of an impending expiry of an existing service plan contract, which will be automatically renewed with a different duration.

The ability to create contracts with Daily-Weekly durations introduces a new version of the "Accounts and Master Plan Instances" provisioning event class (see release note). If you want to leverage new contract-related fields in this event class, contact Aria Support to update it to version 3.6.

Daily-Weekly Contract Duration (DEV-11546)

This feature introduces the ability to create contracts with a daily or weekly duration. You can specify a daily-weekly duration either while creating or modifying a contract. In Account Overview > Plans > Contracts tab, you can select "Specify Duration" for Contract Completion. Then, you can specify a number in the Contract Duration text field and select "days," "weeks," or "months" in the Contract Duration dropdown menu.

Aria will send two new fields in "Accounts and Master Plan Instances" event payloads for Aria instances using version 3.6 of that event class:

• <contract_duration_type>: Indicates whether the contract <duration_length> is based on months, weeks, or days. Possible values are 1—days, 2—weeks, or 3—months.
• <contract_duration_length>: The number of time units specified in the <duration_type> the contract will last after the <start_date> of a contract. 

Related events:

• Account Service Plan Contract Pending Expiration
• Account Service Plan Contract Expired
• Account Contract Created
• Account Contract Edited
• Account Contract Deleted

You can now select these new replacement strings when creating custom contract-related email templates:

• "insertContractDurationLength": Contract Duration Length
• "insertContractDurationTypeInd": Contract Duration Type (numerical value 1—days, 2—weeks, or 3—months)
• "insertContractDurationTypeStr": String associated with above value (days, weeks, or months)

Sale/Authorization Code Enhancement for Vantiv Payment Gateway (DEV-11551)

Aria’s Vantiv (Litle) payment integration previously only recognized response code 000 for a successful sale/auth transaction; now, Aria will treat 141 and 142 as codes for a successful sale/auth transaction also. This applies to the following pay methods: Credit Card, Tokenized Credit Card, and Merchant-Specific Gift Card.

Learn more about Aria's integration with the Vantiv payment gateway from here.

New "Service Type" Replacement String Now Available on Statement Templates (DEV-11552)

This feature introduces the "insertItemLineType" replacement string for inclusion on Statement Templates to indicate the service type for a line. Following are possible values:

New Statement Replacement Strings and API Outputs to Display Activation Charges (DEV-11553)

This feature adds new statement template replacement strings to show totals of activation-related charges and credits on your customers' statements:

• "insertGLTotalActivationCharges"—Total of all activation charges in the invoice (including balance transfer transactions);
• "insertGLTotalActivChgAfterCredits"—Total activation charges minus credits (including balance transfer transactions); and
• "insertGLActivationDiscountCredits"—Total credits on activation charges (including balance transfer transactions).

New "Legal Entity" Replacement Strings Now Available on Statement Templates (DEV-11554)

This feature adds new replacement strings to show Legal Entity information on your customers' statements:

New Loop Available For Displaying Funcional Account Group Information on Statements (DEV-11555)

This feature introduces the loop "beginLoopAcctFunctionGroups" to display Functional Account Group information on statements. Replacement strings available are:

• "insertAcctFuncGrpGroupNo"—Functional Account Group No;
• "insertAcctFuncGrpGroupName"—Functional Account Group Name;
• "insertAcctFuncGrpClientGroupId"—Client Group ID; and
• "insertAcctFuncGrpDescription"—Description.

New "Payment Term" Replacement Strings Now Available on XML Statement Templates (DEV-11556)

This feature adds new replacement strings to show Payment Terms information on XML statement templates. The new replacement strings are: "insertStmtPaymentTermsNo", "insertStmtClientPaymentTermId", "insertEanGlnNumber", and  "insertEanGlnRequisitionNumber".

Webhook Notifications Implemented for Worldline Smart Payments (DEV-11559)

With this release of Smart Payments for the Worldline payment gateway, Aria now supports webhook notifications for the following event types to support changes in transaction status:

• payment.captured
• payment.paid
• payment.reversed
• payment.rejected
• payment.rejected_capture

API-related enhancements for this feature appear below.

Apple Pay Payment Method Now Available With Worldline Smart Payments (DEV-11587)

Aria is excited to introduce Apple Pay as a digital payment method to our Worldline Smart Payments integration. Tokenized payments (initial payments and refunds) are supported for the Mastercard® card type.

To configure Apple Pay for Worldline Smart Payments, navigate to the Apple Pay tab (Configuration > Payments > Payment Gateways/Collection Groups [WorldPay]). Download the Certificate Signing Request (.csr) file (Step 1). After downloading the .csr file, perform the following (Step 2):

• Visit the Apple Pay portal.
• Log into your merchant account.
• Attach the CSR file.
• Get the .cer format file.

After obtaining the .cer file, upload the file from the Apple Pay tab (Step 3) to complete the pre-requisite steps for making Apple Pay payments.

You can now contact Aria with your Apple Pay payload using existing Aria APIs as part of your Worldline Smart Payments integration.

BACS, SEPA and Apple Pay Transaction Logging for Worldline Smart Payments (DEV-11588)

Aria has added the following in support of the Worldline payment gateway as part of Smart Payments integration:

Worldline now supports Tokenized Direct Debit initial and recurring BACS Direct Debit payments (pay method 37) for Create Token and Query Token actions. This also includes integrated transaction logging with masking of sensitive information.

This release also includes support for SEPA Approve Mandate and Capture Payments (pay method 37). SEPA payments are enabled via the following process:

• Create Token (using the create_acct_complete_m API)
• Approve Mandate (using the record_mandate_approval_m API)
• Make a Payment (using the collect_from_account_m API)

Aria now supports transaction logging for Apple Pay transactions from Worldline Smart Payments. To do this, two new fields (dpan and verified_auth_value) have been introduced in the Logging Payment Request to display the Worldline Apple Pay transaction details. As with BACS transaction logging, the dpan value will ben masked as it contains sensitive information.

CCP Quick Search Parameter Expansion (DEV-11600)

The parameters available through Quick Search have been expanded to include the following search parameters that do not require a search operator: Test Account, Account Status, Subscription (Formerly Account Service Plan), and Custom Fields (Formerly Client Defined Account Fields). The search has also been updated to display a comprehensive explanation (via tooltip hover) of why the listed account matches the query.

CCP Pending Invoice List View And Pending Invoice Approval (DEV-11601)

Pending Invoices can now be viewed, recalculated, and approved in Customer Care Portal (CCP) from CCP > Transactions > Pending Invoices. 

Click on the invoice number within the list to expand the Invoice Details pop-out drawer. From this Invoice Details drawer, select the History tab to view a list of previous actions that have been taken on the pending invoice.

To approve an invoice, recalculate an invoice, or View & Print an invoice select the row actions ⋯ on any pending invoice line and then click the action you want to take.

Additional Fraud Feature Support for Worldline Smart Payments (DEV-11637)

With this release, Aria introduces additional fraud security as part of Worldline's Smart Payments integration. An end_user_device_fingerprint field is now included at the Payment Gateway and Collection Group levels (Configuration > Payments > Payment Gateways/Collection Groups > Advanced Options); this field, when used with the <bill_address> field from the validate_acct_fraud_scoring_m API, will limit the number of attempts to validate fraud scoring through this API (10 attempts is the default).

CCP Subscription Billing Group Details Drawer And Actions (DEV-11641)

The Billing Group Details drawer has been updated to enhance the experience of managing billing groups through CCP. You can now access the updated drawer from Subscriptions > Details > Edit. This opens a drawer with the following three tabs:

• Billing Tab: This tab displays the billing group details, which are pre-populated. Users can update these details and manage Statement Recipients’ emails with options to add to both CC and BCC lists.
• Payment Tab: You can now add or select Primary Payment Method, Secondary Payment Method, Collection Group, Statement Contact, and Terms (Note: Terms details cannot be edited).
• Subscriptions Tab: You can now manage subscriptions by assigning or unassigning them from the billing group table.

Token Removed When Removing BACS/SEPA For Worldline Smart Payments (DEV-11668)

When removing BACS/SEPA as a payment method for Tokenized Direct Debit payments (pay method 37), the token associated with that payment is also removed. This can be accomplished within Aria Billing Cloud by navigating as follows:

• Accounts > [search for an account] > Account Overview > Payment Methods (Delete Payment Method)

Account Balance Shows Negative Value Even When There Is A Balance Due (DEV-11673)

The Account Balance calculation has been modified to deallocate the adjusted negative balance forward (Transaction Type 18) from the invoice during the invoice void actions. 

Support Currency Scale Specification For Locale-specific Currency Formats (DEV-11676)

This feature adds support for displaying currency amounts formatted with a Locale-specific currency mask to the currency scale you have specified for your Aria instance (Configuration > Billing > Currencies > (click a currency) > Currency Scale).

Search Web API Logs For set_acct_notify_tmplt_grp_m Via Account Number (DEV-11692)

This feature adds the capability to search Aria's Web Service API Logs by account number for the API call set_acct_notify_tmplt_grp_m, even if you called it specifying a <client_acct_id> or <user_id>.

Installment Terms Phase 4: Extended Use Cases (API)(DEV-11504)

The following API enhancements are included in Phase 4 of NSO Installment Terms:

The get_acct_statement_all_m Core API has been added with this release. This API returns the list of all statements along with installments (when applicable) on an account for all the MPIs or a specified MPI, statement, statement sequence string, secondary statement sequence string, or invoice associated with the account at the time the statement is generated.

create_order_m

The following output has been added:

create_order_with_plan_m

The following inputs have been added:

The following outputs have been added:

get_acct_installment_m

The following input has been added:

Req	Field Name	Field Type	Description
	<installment_no>	Long	Aria-assigned installment schedule no.

The following outputs have been added:

get_invoice_history_m

The following output has been added:

Exclude Future Installment Dues from Collections: Future installment dues are now excluded from collection processes triggered by:

• manage_pending_invoice_m
• collect_from_account_m

Enhanced Bill Date Reset Support For Reactivated Master Plans (DEV-11543)

This feature adds a new option to the <force_bill_date_reset> field in several API calls allowing you to automatically adjust the billing date for a reactivated plan, even if the plan has been suspended for multiple billing cycles. This option will set the next billing date to a future date that aligns with the original billing schedule. This change is available in these API calls: update_acct_plan_status_m, update_acct_plan_m, replace_acct_plan_m, update_acct_plan_multi_m, and edit_acct_plan_queued_changes_m.

Auto-Renew Contracts With Different Durations (DEV-11544)

This feature enhances Aria's support for contracts by introducing the ability to specify a different contract duration for auto-renewal, when either creating or modifying a contract (e.g., you could specify that a contract auto-renew from a monthly contract to a daily-weekly contract). Aria has updated several API calls to accommodate this new functionality.

• create_acct_complete_m
• create_instance_contract_m
• create_acct_universal_contract_m
• modify_instance_contract_m
• modify_acct_universal_contract_m

• get_instance_contract_m
• get_acct_universal_contract_m
• get_all_acct_contracts_m

Daily-Weekly Contract Duration (DEV-11546)

This feature introduces the ability to create contracts with a daily or weekly duration. You can specify a daily-weekly duration both while creating or modifying a contract. New input fields <duration_type> and <duration_length> are added to these APIs to support this functionality: create_acct_complete_m, create_instance_contract_m, create_acct_universal_contract_m, modify_instance_contract_m, and modify_acct_universal_contract_m. 

New API Outputs to Display Activation Charges (DEV-11553)

This feature adds new output fields to show totals of activation-related charges and credits on the API Call get_acct_preview_next_bill_m. The new output fields are: <total_activation_charges>, <total_activation_charges_after_credits>, and <total_activation_discount_credits>.

Webhook Notifications for Worldline Smart Payments (API) (DEV-11559)

In support of webhook notifications for Worldline Smart Payments, validations have been added to the following existing fields of the update_payment_method_token_m API:

• <cc_expire_mm>
• <cc_expire_yyyy>

The following error messages are now included for this API to support this feature:

Update Payment Token via API Added for Worldpay Smart Payments (DEV-11577)

With this release, Aria adds the ability to update token expiry details for Worldpay as part of Smart Payments integration via the update_payment_method_token_m API. This includes the following input fields:

• <cc_expire_mm>
• <cc_expire_yyyy>
• <bill_first_name>
• <bill_last_name>

Avalara Billing Group Company Code API Override of Tax Configuration UI Value (DEV-11581)

Aria has added enhancements to selected APIs to override the Avalara company code at the Tax Configuration screen (Configuration > Integrations > Taxation Configuration > Avalara Tax Service). The new <taxation_company_code> for these APIs will be stored against the respective billing group and will be sent in the tax request of all subsequent invoices for the affected account.

The following APIs have been enhanced to support this feature:

CCP Password Length and Requirements (DEV-11594)

Passwords for Customer Care Portal (CCP) must be a minimum of 12 characters and contain at least one alphabetic, one numeric and one special character (!@$^()+-). These can be reset through legacy Aria APIs and the REST API. Set the Minimum Password Length setting at Client Settings > Miscellaneous Settings.

CCP Subscription List View And Queued Changes (DEV-11595)

The following output fields have been added to the get_acct_plan_queued_changes_m API: 

• <current_rate_schedule_name>
• <target_rate_schedule_name>
• <anniversary_queue_ind>
• <processed_by_batch_ind>
• <execute_allowed>
• <change_effective_date_allowed>
• <delete_allowed>
• <update_date>
• <queue_type>

Allowable Values for <queue_type>

Fraud Scoring Fields Added for Worldpay Smart Payments (DEV-11636)

Aria enables more fields for fraud sight data scoring as part of Worldpay’s Smart Payments configuration. The following fields will be sent for Tokenized Credit Card payments (pay method 13) via the validate_acct_fraud_scoring_m API:

To use this feature, the following must be configured at the Payment Gateway or Collection Group level for Worldpay (Configuration > Payments > Payment Gateway/Collection Groups > Processing Options):

• Send Fraud Sight Request – Enabled

The following fraud score results are returned from Worldpay via validate_acct_fraud_scoring_m when Send Fraud Sight Request is Enabled (from the <proc_fraud_scoring_info> array/ <proc_fraud_score_result> field:

• High-Risk
• Low-Risk
• Review

Token Removed When Removing BACS/SEPA For Worldline Smart Payments (APIs) (DEV-11668)

When removing BACS/SEPA as a payment method for Tokenized Direct Debit payments (pay method 37), the token associated with that payment is also removed. This can be accomplished via the following APIs:

• remove_acct_payment_method_m
• update_payment_method_m