Release 63

OneSource Added To Aria Smart Tax Configuration (DEV-11439)

Aria introduces OneSource as the initial taxation provider included in Aria's Smart Tax integration. OneSource is a leading service for businesses seeking to achieve full tax compliance while maximizing deductions with minimum risk of audits and disruption of operations. OneSource Smart Tax supports tax, post, void, and refund actions through the Aria UI and existing APIs. 

The following fields are included (Configuration > Integrations > Taxation Configuration > OneSource > Configuration tab):

• OneSource Tax REST API URL—The full URL to the REST API configured for OneSource 
• Client id—The client ID configured for OneSource
• Client Secret—The secret string used to identify the client 
• External Company Id—The external company ID configured for OneSource 
• Company Role—A dropdown list to identify the company role (Buyer, Middle Man and Seller) 
• Ship From location with address fields—A dropdown list to select the available service location for the client

Also, a new LineItem/ProductCode field (under the Group Configuration tab) has been introduced to allow you to specify the product code for each line item sent to OneSource during the taxation process (with Service Group 1 and Service Group 2). 

NSO Installments Phase 7: Additional Use Cases and Installment Surcharge (DEV-11593)

For customers, Non-Subscription Offering (NSO) Installments make expensive products more affordable by breaking the total cost into smaller payments that are due over multiple dates. Businesses can record the entire revenue from the NSO sale upfront. 

Phase 7 of NSO Installments enhances installment customization features at the account level for NSO purchases, extending to APIs allowing modifications to installment amounts and thresholds. It also adds a new Account Installment Status Changed event notification to the Account and Master Plan Instances Event Class and an Installment Paid in Full communication class to notify account holders when installments are fully paid, alongside a new installment surcharge feature.

In this release, Aria has introduced installment surcharges that can be applied to NSO installment purchases. Following are requirements for configuring a surcharge to be used for NSO installments: 

• Installment surcharge is only available when the scope is ‘specified item charges’. 
• Installment surcharge has a 1:1 relationship with an NSO. An installment surcharge can only be mapped to one NSO.
• Only surcharges configured with a Rate Calculation Model of Percentage (Multiple Tiers) are applicable. 
• ‘Minimum surcharge to apply’ is not applicable. 

A new version of the Account and Master Plan Instances Event Class, 3.7, adds the following changes to support installments. Contact Customer Support if you want to take advantage of the features in this new event class version.

1. New event 761 Account Installment Status Changed added to version 3.7 or above. This event is triggered when the installment is successfully updated to Completed, Discontinued, or Cancelled. 

2. Existing event 760 Account Installment Assigned is updated to Account Installment Created; and, the associated provisioning comment associated with this event is updated from New Installment Assigned Successfully to New Installment Created Successfully. 

In this release, Aria has added the new email communication class Installment Paid in Full that notifies account holders an installment has been paid in full. This new communication class applies to both aligned and independent installments. The notification will be sent when:

• the installment's remaining balance is $0, and
• all individual statement statuses are ‘Paid.'

Aria has developed a new loop, beginLoopPaidInstallments, for displaying paid installments on statements. Contact Customer Support if you want to leverage this newly available data on your custom statement template. The following values can be used in this loop:

Replacement String	Description and logic
insertPaidInstlSKU	SKU of the item purchased on an installment.
insertPaidInstlOrderNo	The order number of the order of an item paid via installments.
insertPaidInstlInvoiceNo	The original invoice for the installment order (not the aligned invoice of the due installment).
insertPaidInstlScheduleNo	The installment schedule number that has been paid in full.
insertPaidInstlInvoiceDate	The bill date of the original invoice for the order on an installment.
insertPaidInstlUnits	The number of units placed on the installment plan.
insertPaidInstlRate	The rate per unit for the NSO.
insertPaidInstlScheduleAmt	The full amount of the installment schedule less credits and discounts, including taxes.

Chase Paymentech Basic Supported Features For Smart Payments (DEV-11681)

With this release, Chase Paymentech is now included as part of Aria's Smart Payments. Chase Paymentech Basic Smart Payments features include the following: 

• Credit Card and Tokenized Credit Card online payments, including the following card brands:
  • VISA
  • Mastercard 
  • American Express 
  • Discover 
  • Diners Club/Carte Blanche 
• Payment Authorization for Chase Online payments using a credit card or token
• Query Token action using the token (<bill_agreement_id>)
• Payment Capture of previously authorized transactions
• Credit Card Authorization Reversal (implemented via the Aria UI and the reverse_authorized_electronic_payment_m API)
• Refund of a previously authorized transaction back to the customer's original method of payment 
• Soft descriptor support for descriptions accompanying credit/debit transactions to appear on customer's bank statements for Online payments
• 3DS Authentication for VISA and Mastercard payments (settlement in batch) 
• Fraud scoring and fraud filtering (including 3DS support for VISA and Mastercard using the validate_acct_fraud_scoring_m API) 
• CIT (Customer-Initiated Transaction)/MIT (Merchant-Initiated Transaction) Indicator (implemented through the <recurring_processing_model_ind> input of the authorize_electronic_payment_m API for Online payments) 
• Transaction logging supported for the following actions: create token, authorization, payment, and authorization reversal 
• CIT/MIT Recurring Indicators via the <recurring_processing_model_ind> input you can specify in the following APIs to flag recurring transactions as desired:
  • authorize_electronic_payment_m 
  • collect_from_account_m 
  • update_payment_method_m 

Chase Advanced Supported Features for Smart Payments (DEV-11745)

As part of Aria's Smart Payments integration with Chase Paymentech, advanced features, including Level 2 and Level 3 payment data, are now supported. Support for the ACH, BACS and SEPA payment methods along with Strong Customer Authentication (SCA) exemptions have also been added to the set of advanced features for Chase Paymentech.

Additional details are provided as follows:

• Automated Clearing House (ACH) online payments are available specifically for the U.S. and Canada, mapped to payment method 2). ACH batch settlement is also included. 
• Single Euro Payments Area (SEPA) direct debit online payments are now supported also (payment method 26, IBAN indicator: 1). SEPA batch settlement is also included. 
• Bankers' Automated Clearing Services (BACS) direct debit online payments are now supported also (payment method 26, IBAN indicator: 0). BACS batch settlement is also included for one-time and recurring online transactions. 
• For the Real-Time Account Updater (VISA only), Aria supports the following response codes from Chase Paymentech: 
  • J—New card number and new expiry date found 
  • A—New card number found 
  • E—New expiry date found 
  • Q—Contact cardholder (similar to the Batch Account Updater in the legacy Chase Paymentech integration, the Processing Option “Response Code Q Action” in the Collection Group/Payment Gateway configuration will apply to Real-Time account updates as well). 
• Low-value payment SCA exemptions are now supported for eligible transactions within Chase Paymentech Smart Payments based on the SCA exemption type indicator at the Payment Gateway or Collection Group level (this is for batch settlement; the low-value threshold is based on issuer policies).

Chase Paymentech's Advanced features also includes Level 2 and Level 2 data support, as shown:

Level 2/Level 3	Line Item Level/Order Level	Record	Card Brands
Procurement Level 2 (Batch)
	Line Item Level Data	PPC002	All card brands*
Procurement Level 3 (Batch)
	Order Level Record Data	PP0001	VISA, Mastercard
	Line Item Level Data	PP1, Record 1	Mastercard
		PP2, Record 2
		PP1002, Record 1	VISA, Discover, Diner's Club
		PP2002, Record 2

*—Only Level 2 data supported for American Express

Enhanced Payload for the Account and Master Plan Instance Notifications Event Class (DEV-11804)

This feature enhances the Account and Master Plan Instances Notifications Class by adding the <sequential_statement_id> field.  This field will contain the value of <second_acct_statement_seq_str> if it is present. Otherwise, it will hold the value of <acct_statement_seq_str>. Previously, Aria required an additional API call to get_invoice_information_m to retrieve these values. Aria has implemented a new version (3.2) of the payload XSD.

If you are using this Event Notification Class and wish to leverage these fields in your stack, contact Customer Support to update to the latest versions. You can also download the new XSD, or view sample payloads. 

Underscores Now Supported for Object Query APIs On Affected Fields (DEV-11814)

Aria now supports underscores when performing a query against an Object Query API field containing an underscore, using a “Where” operator such as LIKE or NOT LIKE. For example, the query client_acct_id LIKE "4_%” is now supported.

ACCP—Subscription Details Enhancement (DEV-11881)

The Subscription Details page within ACCP has been updated to include the following new and improved functions:

• Subscription status changes now display immediately upon save.
• The Add-On Details drawer found at Subscription > Details > [expand Billing Group] > [expand Subscription] > [select Add-On] now displays information in a tabular format, including: Add-Ons, Services, Subscription fields, and Add-on fields.
• You can enable queued changes from the Subscriptions > Queued changes > Queue tab and Subscription > Details > [expand Billing Group] > [expand Subscription] > [select Add-On] views.
• You can also preview invoices via the “Preview Invoice” button prior to executing changes.

ACCP—Account Status Enhancement (DEV-11882)

The Account Status drawer has been enhanced with the following new features:

• A new dedicated Status Change drawer has been implemented.
• A Change Status button has been added to the existing Account Status drawer.

This enhances the existing Account Status drawer functionality providing account status details, account capabilities, and a status history view.

SEPA Direct Debit Refunds Added for Buckaroo Smart Payments (DEV-11886)

Aria now supports Single Euro Payment Area (SEPA) Direct Debit and Tokenized Direct Debit (pay methods 26 and 37) for refunds via the Buckaroo Smart Payments integration. Buckaroo supports both full and partial refunds, which can be initiated and completed via the Aria UI and the issue_refund_to_acct_m API call. 

This enhancement also includes transaction logging for the SEPA query_token pay action (pay method 37). Transaction logging is captured for both success and failure cases, handling different logging types (FULL, ERROR, SUMMARY, and NONE) when generating the transaction log entry.

Dunning support is also provided for payment failures as part of the webhook notification process. Additionally, if charges are applied to a child master plan instance (MPI), the child MPI (with parent pay) will be sent to Dunning in the event of payment failure.

iDEAL Direct Pay Method Supported for Buckaroo Smart Payments (DEV-11911)

With this release, iDEAL, an e-commerce payment system used for online banking in the Netherlands, is now supported through your Buckaroo Smart Payments integration as an alternative pay method.

Note: Enabling iDEAL Smart Payments is accomplished via the record_alternative_payment_m API. More information appears on this page (below).

Buckaroo supports Return URL options to which the customer will be redirected after completing an iDEAL payment. To support this, Aria introduces the following options to configure based on need (Configuration > Payments > [Payment Gateways/Collection Groups] > Processing Options tab):

Label	Tooltip
Payment Return URL	The default URL where customers are redirected after payment. If left blank, the Payment Plaza URL is used. Configure other URLs for specific actions like cancel, error, or reject.
Payment Cancel Return URL	Alternative URL for transactions cancelled by the customer.
Payment Error Return URL	Alternative URL for transactions with processing errors.
Payment Reject Return URL	Alternative URL for rejected transactions.

Additionally, Buckaroo supports iDEAL partial and full refunds, which can be issued through the Aria UI.

NSO Installments Phase 7: Additional Use Cases and Installment Surcharge (DEV-11593)

Aria has extended several APIs with fields enabling account-level overrides during NSO purchases and supporting surcharges for Phase 7 of NSO Installments. The account overrides enable you to edit or modify installment attributes configured in the product catalog, plus any account-specific attributes such as installment amount (tax inclusive) and last installment amount threshold. Surcharge support allows you to enable a surcharge for an installment schedule, or get surcharge information related to an installment schedule.

For non-API-related updates, refer to Release 63 updates to NSO Installments above.

Field Name	Type	Description
<installment_amount>	float	Specifies the individual installment amount, inclusive of tax. For example, if a purchase is taxed at 15%, a $20 installment amount will be split into $17.39 (charge) and $2.61 (tax). The total tax-inclusive purchase amount will be divided by this amount to calculate the length of installment. Note: If this field is provided, the <installment_term_length> field will be ignored.
OR
<installment_term_length>	Int	Specifies the installment term length for the assigned installment.  For <installment_type> = 2, the input will be used jointly with the interval type. For <installment_type> = 1, this will be the number of statements that the installment amount will be part of.
<aligned_installment>	string	Aligned installment schedule with existing master plan instance. Allowable Values Values Description Y Aligned with existing master plan instance. If aligned, installment amount will be charged along with master plan instance anniversary statement. N Its own installment schedule and due dates
<installment_term_type>	string	Specifies the installment term type for the assigned installment. Allowable Values Values Description M Months W Weeks D Days
<installment_interval>	Int	Specifies the installment interval for the assigned installment, applicable only for independent installment. It works jointly with terms type. If defined, must be less than terms length.
<days_until_due>	Int	Specifies the number of days until due for the independent installment. Applicable only when <installment_type> = 2 or installment term defined on product catalog is <aligned_installment> = N. Determines how many days after customer is notified on the installment that it's due. If 5 is passed, then 5 days after customers are notified, the installment will be due.
<installment_lump_sum_type>	string	Specifies the installment lump sum type for the assigned installment. Allowable Values Values Description P proportionately split charge/tax T purchase tax only
<installment_lump_sum_amount>	float	Specifies the lump sum amount, mandatory when lump sump type is proportionately split (<lump_sum_type> = P).
<installment_aligned_lump_sum>	string	Applicable only for aligned installment. Determines when to notify customers of the lump sum.   Allowable Values Values Description 0 Aligned with when an invoice is created 1 Aligned with the 1st installment
<installment_lump_sum_days>	Int	Specifies the lump sum days. Applicable only for independent installment (<update_installment_type> = 2 or installment term defined on product catalog is <aligned_installment> = N). Determines how many days after a purchase or invoice date that a lump sum is charged and be notified to customers.
<installment_lump_sum_days_until_due>	Int	Specifies the lump sum days until due, applicable for both types of installment. Determines how many days after customers are notified that a lump sum is due.
<last_installment_amount_threshold>	float	Specifies the percentage used to calculate the allowable additional amount for the last installment's threshold. For example: If the installment amount is $50 and the remainder is $80, with 0%, the remainder is split into $50 and $30 (last installment). With 90%, the allowable additional amount is $45, making the last installment threshold $95. In this case, the last installment amount will be $80. If set to NULL, it defaults to 0%.

Field Name	Type	Description
<installment_schedule_info>	array	Installment schedule info array
<installment_no>		Aria assigned installment schedule no
<seq_no>		Aria assigned seq schedule no
<notify_date>		Dates when customer will be notified of an installment.
<due_date>		Due dates of when individual installment is due
<due_amount>		Amount due of each individual installment

Field Name	Type	Description
<master_plan_nso_list> (array) <independent_installment_date>	string	Defines the start date of independent installment, needs to be the same or greater than the current date. If passed, the associated <days_to_start> and <lump_sum_days> value will be ignored.
<installment_amount>	double	Specifies the individual installment amount, inclusive of tax. For example, if a purchase is taxed at 15%, a $20 installment amount will be split into $17.39 (charge) and $2.61 (tax). The total tax-inclusive purchase amount will be divided by this amount to calculate the length of installment. Note: If this field is provided, the <installment_term_length> field will be ignored.
OR
<installment_term_length>	long	Specifies the installment term length for the assigned installment.  For installment_type = 2, the input will be used jointly with the interval type. For installment_type = 1, this will be the number of statements that the installment amount will be part of.
<aligned_installment>	string	Specifies installment type for the account, whether installment should be aligned with master plan instance or independent. Allowable Values Values Description Y Yes (Aligned) N No (Independent)
<installment_term_type>	string	Specifies the installment term type for the assigned installment, applicable only for independent. Allowable Values Values Description M Months W Weeks D Days ~ Null
<installment_interval>	long	Specifies the installment interval for the assigned installment, applicable only for independent installment. It works jointly with terms type. If defined, must be less than terms length.
<days_until_due>	long	Specifies the number of days until due for the independent installment. Applicable only when <installment_type = 2> or installment term defined on product catalog is <aligned_installment> = N. Determines how many days after customer is notified on the installment that it's due. If 5 is passed, then 5 days after customers are notified, the installment will be due.
<installment_lump_sum_type>	string	Specifies the installment lump sum type for the assigned installment. Allowable Values Values Description P Proportionately split charge/tax T Purchase tax only ~ Null
<installment_lump_sum_amount>	double	Specifies the lump sum amount, mandatory when lump sump type is proportionately split (<lump_sum_type> = P).
<installment_aligned_lump_sum>	long	Applicable only for aligned installment. Determines when to notify customers of the lump sum. Allowable Values Values Description 0 Aligned with when an invoice is created 1 Aligned with the 1st installment
<installment_lump_sum_days>	long	Specifies the lump sum days. Applicable only for independent installment (<update_installment_type> = 2 or installment term defined on product catalog is <aligned_installment> = N). Determines how many days after a purchase or invoice date that a lump sum is charged and be notified to customers.
<installment_lump_sum_days_until_due>	long	Specifies the lump sum days until due, applicable for both types of installment. Determines how many days after customers are notified that a lump sum is due.
<last_installment_amount_threshold>		Specifies the percentage used to calculate the allowable additional amount for the last installment's threshold. For example: If the installment amount is $50 and the remainder is $80, with 0%, the remainder is split into $50 and $30 (last installment). With 90%, the allowable additional amount is $45, making the last installment threshold $95. In this case, the last installment amount will be $80. If set to NULL, it defaults to 0%. Valid values are 0 to 99.

Field Name	Type	Description
<installment_schedule_details array> <installment_principal_due>	double	Installment principal due amount of each individual installment.
<installment_principal_tax_due>	double	Sum of principal tax due amount of each individual installment.
<installment_surcharge_due>	double	Installment surcharge due amount of each individual installment.
<installment_surcharge_tax_due>	double	Sum of surcharge tax due amount of each individual installment.

Affected APIs	Input/Output	Field Name	Field Type	Description
create_surcharge_m	Input	<installment_surcharge_ind>	Integer	Indicates whether the surcharge should be spread over installment period. Applicable only when an item is purchased with installment. Allowable Values Values Description 0 Surcharge will not be spread over installment period 1 Surcharge will be spread over installment period. Note: Null should be treated as 0 (Zero).
get_surcharges_m get_surcharge_details_m	Output	<installment_surcharge_ind>	Integer	Indicates if the surcharge should be spread over installment period. Applicable only when an item is purchased with installment. Allowable Values Values Description 0 Surcharge will not be spread over installment period 1 Surcharge will be spread over installment period.
get_plan_details_m	Output	<installment_terms> (hash) <is_default>	Integer	The value of 1 is defaulted for the first installment term denoting it is the default. For subsequent installment terms, the default is set to 0. Alternate boolean values are accepted.

 

 

Improved Error When Cancelling Plan With Multiple Active Contracts (DEV-11800)

When attempting to cancel a plan instance associated with more than one active contract via the update_acct_plan_multi_m API, Aria now returns the following error code and message.

Error Code	Error Message
16037	Action cannot be performed since there are multiple active contracts on the same Plan Instance.

iDEAL Direct Pay Method Supported for Buckaroo Smart Payments (API) (DEV-11911)

Perform the following steps to enable iDEAL Direct payments:

1. Once the invoice and statement is generated for the account, initiate the iDEAL payment using the record_alternative_payment_m API with the following inputs: 
   • <account_no>
   • <reference_code>
   • <payment_amount>
   • <processor_id> (41 for Buckaroo)
   • <pay_method_type> (49 for iDEAL—Direct pay method number)
2. Once the record_alternative_payment_m API is executed with the above inputs, a <payment_redirect_issuer_url> is returned in the response.
3. You should invoke this <payment_redirect_issuer_url> value in your browser to complete the iDEAL payment (where your customer is redirected to the issuer/bank page in which they will pass bank details and complete the payment).
4. Once the iDEAL payment is completed, the status of the payment will be updated in Aria via webhook notification. As part of notification, Aria will also retrieve the token associated with the initial iDEAL payment and the new <billing_info> sequence for Tokenized Direct Debit will be created along with the token details.
5. For subsequent transactions, you will use the new <billing_info> sequence (for the Tokenized Direct Debit pay method) created in the previous step. 

Additionally, Buckaroo supports iDEAL partial and full refunds, which can be issued via the issue_refund_to_acct_m API.

Retrieve Detailed Payment Unapplication History with New API get_payment_unapplication_details_m (DEV-11914)

This feature introduces a new API, get_payment_unapplication_details_m, designed to retrieve historical payment unapplication details based on either a <transaction_id> (for payments) or a <voiding_transaction_id> (for payments or charges). Depending on the input, the API returns either an <impacted_charges> array for payment-related transactions or an <impacted_payments> array for void-charge transactions, with both arrays including the <unapplication_amount> grouped by a unique <unapplication_no>.

<schedule_no> Now Included in get_inventory_item_details_m API (DEV-11918)

The get_inventory_item_details_m AdminTools API now includes the following output field:

Field	Type	Length	Description
<schedule_no>	long	10	Schedule number for the inventory item currency

This field is used in addition to the existing <client_rate_schedule_id> output field within the <schedule> output array when updating rate schedule information for non-subscription offerings.