Release 65

Additional APIs Searchable by <acct_no> when <client_acct_id> Input (DEV-9008)

This feature enhances the update_acct_complete_m and set_payment_responsibility_m APIs, enabling you to search Aria's Web Service API Logs by account number when these APIs are invoked with <client_acct_id> as input, rather than <acct_no>.

Webhook Notification for dispute_lost Now Honored for Braintree Smart Payments (DEV-11791)

For Braintree Smart Payments, Aria now updates a payment status as “failed” in support of the dispute_lost webhook notification event. This is applicable for both Braintree Payment Gateway and Collection Group configurations (Configuration > Payments > Payment Gateways/Collection Groups). Supporting this webhook event helps to ensure more efficient processing for the entity that is the subject of the dispute as well as the customer seeking dispute resolution.

Plan-Instance-Specific Coupon Assignment (DEV-11805)

This feature allows you to attach coupons at the individual plan instance (Master Plan Instance—MPI or Supplemental Plan Instance—SPI) level, evolving Aria's coupon functionality beyond the existing MPI-stack-or-account-level model. For example, this more granular coupon application scope can offer a discount for an additional house alarm subscription (plan instance) if a customer expands an existing residence and requires additional alarm coverage.

The discount application process prioritizes multiple coupons as follows:

1. PI-level coupons
2. MPI stack coupons
3. Account-level coupons

Future plan queue and invoice generation processes support this new feature.

Chase Paymentech Complete Supported Features For Smart Payments (DEV-11806)

Aria adds functionality to its Smart Payments integration with Chase Paymentech in this release, including the following:

• Apple Pay Payments
• Apple Pay Shipping Contact Details
• Supported Actions for Batch AU Receiver
• Response Error File Handling
• Other Features

The following Apple Pay payment types are supported as shown:

The following Apple Pay shipping contact details are now extracted and stored within Aria when recording a payment:

• ship_fname
• ship_lname
• ship_addr_ln1
• ship_addr_ln2
• ship_addr_ln3
• ship_city
• ship_state
• ship_zip
• ship_country
• ship_email
• ship_phone

The following actions are now supported for the Chase Batch Account Updater (AU) Receiver:

Files with the following error codes are handled and logged appropriately:

• Non-ASCII characters sent in the Chase batch are now replaced with a dot (.) per the Chase batch specification. This applies to the following fields:
  • first_name
  • last_name
  • middle_initial
  • address1
  • address2
  • city
  • state
  • zip
  • country
• Aria now honors multiple company codes for Chase configured within the payment gateway and collection account group levels. All the collection account groups (plus the payment gateway) are grouped based on the company code and sent as a file per company code basis.
• Aria also now displays enhanced authorization information in API responses and also in the UI using additional information received in the CT02 record from Chase, including the following fields:
  • prepaid_ind
  • prepaid_card_type
  • affluence_type
  • issuing_country
  • card_product_type
  • signature_debit_ind
  • pinless_debit_ind
  • durbin_regulated_ind
• Click here to view an API-related enhancement for Chase Smart Payments.

CCP Fixes and Improvements (DEV-11876)

The following enhancements have been added for CCP:

1. Fixed Parent-Child Account Hierarchy Display:
   The parent-child account hierarchy now displays correctly for large account structures, ensuring that you can view complete account hierarchies regardless of size. This enhancement provides reliable access to hierarchical account information.

2. Enhanced Tokenized Credit Card Refund Method Identification:
   The refund method display has been improved with clear labels for tokenized credit cards. This enhancement helps you easily identify and distinguish between different payment methods when processing refunds.

3. Parent-Child Privileges Enhancement:
   CCP now properly enforces parent-child privilege relationships, where disabled parents’ privileges automatically restrict associated child privileges. This update ensures consistent permission handling between CCP and Aria Billing.

CCP Partial Invoice Dispute and Write-Off at Invoice Level for CCP (DEV-11922)

Partial Invoice disputes and Write-Offs are now available in CCP with the following capabilities:

1. Added Disputable Amount Column to Invoice Views of write-off and disputes:
   The invoice tables for write-off and disputes have a new Disputable column. This column displays the amount available for dispute and write-off actions. The existing Total Paid column has been hidden by default to optimize screen space for this new functionality.

2. Separated Write-Offs and Dispute Holds Interface:
   The billing specialist workflow has been enhanced by separating Write-Offs and Dispute Holds into distinct tabs. Each tab has a dedicated creation button providing clear categorization and easy access to specific transaction types.

3. Enhanced Write-Off Interface with Drawer Functionality:
   The write-off workflow has been improved by converting the Write-Off form to a drawer interface. You can now enter a specific write-off, enabling both invoice level partial write-offs and full write-offs. This Write-Off drawer also displays invoice balance information, providing context while processing write-offs.

4. Enhanced Invoice Disputes Interface with Drawer Functionality:
   The invoice disputes feature has been enhanced by converting the Disputes form to a drawer interface. You can now enter specific dispute amounts, enabling both invoice level partial disputes and full disputes. This Disputes drawer also displays select invoice balance information, providing context while processing disputes.

5. Added Settle Dispute Action for Active Disputes:
   A new Settle Dispute action has been added in the Disputes list row action menu for active dispute records. This action is only visible for unsettled disputes and opens a dedicated drawer when selected. The Settlement drawer displays previous dispute information and provides a form to complete the dispute settlement process.

Credit Memo XML Sent Via XML Master File (DEV-11932)

Credit Memos are now available in a standardized XML format for utilization by your chosen document partner. The Credit Memo information is now included along with the Statement information in the XML Master File output as part of the existing “Batch Process 10: Bulk statement file”. The Credit Memo data can be seen in the <cm_no> field within the event payloads. This update is applicable for the below notification methods:

• Notify Method 13: XML Master File
• Notify Method 15: XML Master File and HTML Email
• Notify Method 16: XML Master File and Text Email

CCP Subscription Details Plan Instance Page Enhancement (DEV-11960)

The Subscription Details page has been enhanced with the ability to easily navigate to specific child accounts directly from the Payment Responsibility table via the Switch to Child Account action in the row action menu. To view this new functionality, navigate to:

Subscriptions > Details > [expand a Billing Group ID] > [select a Subscription] > [select Payment Responsibility from the View dropdown] > [hover over the horizontal ellipsis … on a Child Account line] > [select Switch to Child Account].

Additionally, the hover tooltip for Add-On names on the Subscription > Details page has been updated to display the Add-On number instead of the Parent Subscription number.

Enhanced Partial Invoice Dispute and Write-Off Support (DEV-11993)

This feature enhances the partial invoice dispute functionality added in Release 64. The Aria Billing Cloud UI now supports the creation of partial invoice disputes. 

• The Invoice Detail Page in the Aria Billing Cloud UI (Account > Statements & Invoices > Invoices > [Invoice#]) is enhanced. The Write-Off label for fully written-off Invoices is changed from "Invoice Number: 123456 has been written off" to "Invoice Number: 123456 has been fully written off."
• The Partial Write-off labeling has improved: we removed the label "has been written off" for partially written-off invoices.
• If an open balance remains, the following links are now enabled:
  • Apply a Payment
  • Apply Cash Credits
  • Write-Off/Dispute Invoice
• If no balance remains, these links are disabled.

Installment for NSO Phase 9: Enhancements and Additional Use Cases (DEV-11995)

This ticket introduces multiple enhancements and fixes a few issues related to installment schedules. Additional improvements involve verifying payment unapply scenarios and ensuring proper handling of future installment collections. Financial Accuracy has been enhanced by excluding installment surcharges from dunning fee calculations and sending zero-dollar statements when an installment due. New statement template strings have also been added to display remaining balance and paid-to-date amounts.

• Copy Configuration Enhancement—Resolved unique constraint errors encountered during the import process.
• Dunning Compatibility Enhancement—Excluded future installment surcharge from dunning fee calculation to prevent overcharging.
• Statement Sending Enhancement—Added new replacement strings to statement templates to display installment remaining balance and paid-to-date. In the loop beginLoopAlignedInstallments, paid-to-date is shown via insertAlignedInstlPaidtoDateAmt; and remaining balance is shown via insertAlignedInstlRemainingBalAmt.

Vertex Added to Aria's Smart Tax Integration (DEV-12002)

In this release, Aria adds Vertex as a Smart Tax integration for tax, post and void actions. Vertex is a global tax solution provider, and Vertex Smart Tax uses RestClient for more efficient interaction with Vertex APIs. Along with access token generation for streamlined tax processing, this integration also adds a custom request interceptor for handling file headers and logging, as well as a custom response error handler to manage API errors effectively. Vertex Smart Tax also includes implementing common tax data contracts for consistent tax processing.

The following fields have been added in support of the Vertex O Smart Tax taxation configuration: (Configuration > Integrations > Taxation Configuration > Vertex Smart Tax > Configuration tab).

The following fields from Aria's legacy Vertex integration are also included as part of the tax request in the Vertex O Series Smart Tax integration:

Configuration tab

• ShipFromLocation
• BillFromLocation
• FlexibleCodeField[1-25]
• FlexibleNumericField[1-10]
• FlexibleDateField[1-5]
• IgnoreActionTypes
• include_zero_tax
• SkipDefaultLineLevelDestinations
• posting_date_for_void_action
• posting_date_for_reversal_action
• posting_date_for_write_off_action
• posting_date_for_credit_memo_action

Group Configuration tab

• Product/productClass
• LineItem/LineType
• LineType/direction
• LineType/content
• LineType/status
• Quantity/unitOfMeasure
• CommodityCode/commodityCodeType

3DS Authentication/Language Support for Evertec Smart Payments (DEV-12012)

For Evertec Smart Payments, Aria adds 3DS authentication followed by payment in a Direct Post configuration (as a reminder, Direct Post is a feature in Aria Billing Cloud that allows clients to process payments directly through their registration or user self-service (USS) applications). The 3DS Notification URL setting is under 3DS Authentication Settings at the Processing Options tab (Configuration > Payments > Payment Gateways/Collection Groups).

Also, a Language field has been added in the Evertec Processing Options tab for locale API support (under API Response Settings). This setting changes the language of the messages returned by the API, allowing you to view responses in your preferred language. Please refer to Evertec’s documentation for a list of supported languages. The four options are as follows:

The default language selection is English (en) – United States.

Buckaroo Smart Payments: 3DS Authorization for Direct Post (DEV-12016)

Aria adds 3DS authorization via Direct Post for Buckaroo Smart Payments in this release. To accomplish this, the 3DS Notification URL value should reflect the environment from which the authorization will be generated (under 3DS Authentication Settings at the Configuration > Payments > Payment Gateways/Collection Groups > Processing Options tab). This environment URL should match the Success Redirect URL in your Direct Post configuration (Configuration > Client Settings > U.S.S. Reg Configuration).

Support for UI Authentication and MFA Compliance (DEV-12015)

The following enhancements have been added to the Aria Billing MFA to support UI authentication and compliance:

• Support has been added for OTP codes in authenticator apps such as Google Authenticator and Microsoft Authenticator.

  1. The OTP page (the one after the login page) now includes a Configure Authenticator link. This link, as well as the Verify Code button, is enabled once a full OTP code is entered. If clicked, and the code is valid, you are now navigated to the New Auth Code page.

  2. The New Auth Code page:

     • Shows qrcode for an authenticator app code. You can enter this in your phone by taking a picture of the qrcode.

     • Shows the text of the token secret. You can manually enter this token to create an entry in an authenticator app.

     • You must enter an OTP code generated by the authenticator app with this new entry. This code is validated specifically against the newly created token. Other codes that you may have, such as a static password or even another authenticator app code, are not accepted in this circumstance.

  3. If you have an authenticator app configured, your next login will no longer automatically send an email with the assumption that you would rather use your chosen auth app. However, there is still a link on the OTP page to optionally send an email if needed.

• The issue with passwords being improperly reset in User Access Management APIs has been corrected.

• If you are nearing being locked out because of too many failed code entries on the OTP page, a warning is displayed with the number of remaining attempts.

CCP All Service Rates List View Enhancement (DEV-12020)

The Add Custom Rates table found at Subscriptions > All Service Rates > [select a Subscription or Add-on] > View Details > Add Custom Rates has been enhanced for a better user experience in the following ways:

• The workflow for adding new rate tiers in the Add Custom Rates drawer via the Add Rate Tier button has been improved to ensure the rate tables smoothly adjust when new rows are added.

• The error that previously occurred while adding or updating rate tiers via the Add Rate Tier button has been corrected. CCP now properly validates and saves custom rate information, ensuring that all required rate data is processed correctly without displaying an error upon saving.

Usage Event Notifications XML—Add Details Relating to Crossed Unit Usage Threshold (DEV-12039)

The Usage Threshold event notification now includes the “usage_unit_threshold” XML fields, other unbilled usage summary data fields, and the previously missing name-value pairs and support for email and XML order methods in usage monitoring events.

Tokenized Apple Pay and Google Pay for Braintree Smart Payments (DEV-12051)

With this release, Tokenized Apple Pay (pay method 47) and Tokenized Google Pay (pay method 51) have been added as accepted payment methods for the Braintree payment gateway within Smart Payments. These methods accept the Visa, Mastercard, American Express and Discover card types.

API-related details for this feature can be accessed from here.

Discarding Usage Adjusts the Usage_units_measured Used for Event Notifications 1111 and 1112 (DEV-12064)

Usage discarded through the Aria Billing UI now correctly adjusts the <usage_unit_measured> field units. Previously, discarding usage did not update the <usage_units_measured>, resulting in the failure to trigger usage event notifications. The affected usage event notifications appear below:

APIs Enhanced to Support Plan-Instance-Specific Coupon Assignment (DEV-11805)

This feature allows you to attach coupons at the individual plan instance (Master Plan Instance—MPI or Supplemental Plan Instance—SPI) level, evolving Aria's coupon functionality beyond the existing MPI-stack-or-account-level model. For example, this more granular coupon application scope can offer a discount for an additional house alarm subscription (plan instance) if a customer expands an existing residence and requires additional alarm coverage.

Aria enhanced several APIs to support this feature.

Chase Paymentech Complete Supported Features For Smart Payments (API)(DEV-11806)

The <proc_status_text> for all processor response actions is now returned from Chase Paymentech for the following APIs:

• create_acct_complete_m
• collect_from_account_m

Enhanced Partial Invoice Dispute and Write-Off Support (DEV-11993)

This feature enhances the partial invoice dispute functionality added in Release 64. The create_writeoff_or_dispute_m API now supports disputes for specific invoice lines. The get_acct_writeoff_or_disputes_m API returns all the expected information in the array <writeoff_detail> for dispute holds. Improved error messaging information follows API update table.

• Error code "29010 Invalid responsible acct_no or client_acct_id" returns when you attempt a write-off or dispute hold on a parent-pay invoice using a child account number. This applies to both full and partial invoice write-offs or disputes.
• Aria fixed an error in handling write-offs on pending invoices with the <writeoff_dispute_amount> input:
  • Earlier error details—"1025 amount not positive"
  • Updated error details—"3004 Invoice does not exist"
• Duplicate <line_no> inputs in arrays affecting write-off amount calculations now result in the error code "1015 line_no contains duplicate values.”

Installment for NSO Phase 9: Enhancements and Additional Use Cases (DEV-11995)

This ticket introduces multiple enhancements and fixes a few issues related to installment schedules. Key API fixes and enhancements are listed below. 

Aria enhanced several APIs to correctly return <due_date> and <notify_date> for lump sum installment schedules. Previously, incorrect values were returned when you created an aligned installment with account override lump sum options, but without providing <installment_aligned_lump_sum>, and the client's installment term had no "Lump sum" configuration.

Now, if you provide <installment_lump_sum_type> via override, but <installment_aligned_lump_sum> is missing, and the client’s term lacks a lump sum setup, the system will default to "0—Aligned with invoice creation". This change addresses the following APIs:

• create_acct_complete_m
• create_order_m
• create_order_with_plan_m
• update_acct_installment_m
• get_acct_installment_m
• get_invoice_details_m

• Corrected the installment term information to reflect the correct term interval and other details.
• Refactored for improved performance in calculating <invoice_line_total_amount> and fetching installment numbers.

Aria added the field <installment_translations> to the create_installment_term_m API to support translations of installment-related values related to your locale configurations. Each object in the array must include the listed fields.

Tokenized Apple Pay/Google Pay for Braintree Smart Payments (API)(DEV-12000)

As part of Braintree's support for Apple Pay and Google Pay payments, Aria has implemented an alternative payment flow using the record_alternative_payment_m API. You must first complete the client-side workflow with credit cards on Apple Pay and Google Pay, get the Nonce value and pass that value in the <reference_code> input field to complete the initial payment. Then, Aria will store the token that is generated which will be used for recurring payments. Refunds are supported also after payments via Apple Pay and Google Pay are settled.

Additionally, a new <fraud_field> array has been introduced for the record_alternative_payment_m API. The field values for this API appear below:

The following fields have been implemented as allowable values to be sent in the <fraud_field> array for Apple Pay and Google Pay for Braintree to complete the initial payments:

The following fields must be populated to apply a payment via Apple Pay or Google Pay using the record_alternative_payment_m API:

1. <reference_code> – Nonce value created outside based on Apple Pay or Google Pay
2. <statement_no> - Aria statement number 
3. <processor_id> – 28
4. <pay_method_type> – 47 (Tokenized Apple Pay) or 51 (Tokenized Google Pay)
5. <payment_auth_received> - 1
6. <proc_payment_method_id> - <>
7. <primary_payment_method_ind> - 1 - If this is passed, then Aria will map the created billing sequence with the billing group passed in the input or statement’s Billing group.

Apple Pay and Google Pay accept the following card brands:

• Visa
• Mastercard
• American Express
• Discover

Aria will set the input field in the record_alternative_payment_m API based on the following order of precedence:

• Value as part of the <fraud_field_array> input
• Value from the Collection Group configuration
• Value from the Payment Gateway configuration

Aria will set the input field in the validate_acct_fraud_scoring_m API based on the following order of precedence:

• Value as direct input into API
• Value as part of the <fraud_field_array> input
• Value from the Collection Group configuration
• Value from the Payment Gateway configuration