Release 68
- Last updated
- Save as PDF
Note: This is a draft version of the release notes for Aria Billing Cloud—Version 68, which is currently available in Stage Future.
Overview
Enhancements and fixes to Aria functionality for this release are described below.
Release Date
Stage Future Release Date
09-December-2025
System Requirements
Supported Browsers
Aria supports the latest stable versions of the following Web browsers:
- Chrome 63
- Firefox 52
- Microsoft Edge
- Safari 11 on MacOS
Screen Resolution
1024 x 768 or higher
Release 68 Contents
- Application Features
- New Statement Template String: Usage Unit Type Description (DEV-11829)
- Ability to Configure Default Country for New Accounts (DEV-11835)
- New Generic Rebill and Credit Memo Email Templates Available (DEV-11836)
- Three New Coupon-Related Events (DEV-11837)
- CCP—Enhanced Credit Memo Functionality (DEV-11862)
- CCP—Advanced Account Search Enhancement (DEV-12059)
- 3DS Indicator No Longer Processed for Evertec Smart Payments (DEV-12069)
- Client Number Added to Transaction Log for Evertec Smart Payments (DEV-12076)
- Address Validation Added for Avalara Sales and Use Smart Tax(DEV-12161)
- Cybersource Smart Payments Integration—Phase 1 (DEV-12193)
- Payment Plans Phase 3: Cancellation, Dunning Configuration, and Other Use Cases (DEV-12217)
- PayPal Smart Payments Phase 3 (DEV-12233)
- CIT/MIT Now Supported for JCB Cards via Chase Paymentech Smart Payments (DEV-12287)
- CCP—Additional Payment Methods and Billing Types Now Supported (DEV-12290)
- Apple Pay Now Supported Through Adyen Smart Payments (DEV-12339)
- CCP—View Only Option for Billing Group Details Drawer (DEV-12345)
- CCP—Manage Child Accounts Pop-Out Drawer Enhancement (DEV-12346)
- Billie Updates (DEV-12349)
- Application Fixes
- API Features
- New API to Retrieve Open Balance Due for Invoice Line Items (DEV-11825)
- Ability to Configure Default Country For Newly Created Accounts (DEV-11835)
- Plan Update APIs Enhanced With Plan Instance Queue Editing (DEV-12160)
- Payment Plans Phase 3: Cancellation, Dunning Configuration, and Other Use Cases (DEV-12217)
- PayPal Smart Payments Phase 3 (API)(DEV-12233)
- Specify Order of Discount Rules Returned by get_discount_bundle_details_m API (DEV-12239)
- APIs Enhanced to Return Pending Balances (DEV-12259)
- Apple Pay Now Supported Through Adyen Smart Payments (API)(DEV-12339)
- API Fixes
- WSDL File Locations
Application Features
New Statement Template String: Usage Unit Type Description (DEV-11829)
This feature adds a new replacement string to statement templates that pulls the usage unit type description for invoice line items, improving statement clarity for your customers. Contact your Aria representative to update your usage-based statement templates by including this new text description.
Ability to Configure Default Country for New Accounts (DEV-11835)
This feature enhances country configuration in your Aria instance, allowing you to set a default country in the Aria UI via a new dropdown field "Default Country?" When you select "Yes," Aria assigns this country to new accounts created with no country specified (the default value is "No"). This enables Aria to send taxation information for new accounts, even if you do not assign a <country> value to an account.
If you have not set a default country, Aria defaults to "US." Aria also applies this logic to account contacts via the API and UI. Billing or statement contacts and related currency/email functions still retain their previous behavior and will continue to default to “US” or remain null where applicable.
Note: See the API writeup for this ticket regarding enhanced behavior of create_acct_complete_m.
New Generic Rebill and Credit Memo Email Templates Available (DEV-11836)
This feature introduces two new email templates to inform customers of Rebills and Credit Memos. To take advantage of either of these templates, contact Customer Support to enable and customize "Rebill Notification" (template class RB) and "Credit Memo Notification" (template class CM).
Three New Coupon-Related Events (DEV-11837)
This feature introduces three new coupon-related events in the Accounts and Master Plan Instances event class:
- Coupon Assigned (Event 765)—fires when a Coupon is added to a customer’s Master Plan Instance (MPI) or Account;
- Coupon Cancelled (Event 766)—fires when you cancel an existing Coupon on an MPI or Account; and
- Coupon Expired (Event 767)—fires when a Coupon expires for an Account.
Notes:
- You must be subscribed to Accounts and Master Plan Instances version 3.9 to leverage these new events. Contact Customer Support to update your provisioning settings.
- Aria will trigger the Coupon Expired event for all active coupons assigned within the past 1 year, up to the release date of this feature.
These events can also provide you greater visibility and operational efficiency if you leverage coupons in Aria Billing Cloud.
CCP—Enhanced Credit Memo Functionality (DEV-11862)
A new ‘calculation’ feature has been added to the New Credit Memo drawer seen at Transactions > Credits > Credit Memos subtab > New Credit Memo button > Create Credit Memo drawer. This new feature allows you to calculate amounts for price change or cancellation credit memos based on a given date range.
If a calculated value is invalid, for example a negative value for the date range selected, a message displays informing you that a credit memo cannot be created for your selected entry.
Additionally, you can now apply credit to already created credit memos from the Transactions > Credits > Credit Memos subtab. To apply credit, expand your selected existing credit memo from the list, select the ⋯ row actions, and choose the Apply Credit option.
CCP—Advanced Account Search Enhancement (DEV-12059)
The new search operator, Is One Of, has been added to the Advanced Account Search in CCP. This new operator allows you to search a list of different criteria in one single search. For example, previously to search for a Client ID that contains any of the three following strings of numbers, you would need to compound searches by using the Equals and the OR operator as follows:
- ClientID Equals 1234 OR
- ClientID Equals 5678 OR
- ClientID Equals 9000
Now, with the new Is One Of operator, you can easily search for all these search criteria in one search using syntax as follows:
- ClientID Is One Of 1234, 5678, 9000
3DS Indicator No Longer Processed for Evertec Smart Payments (DEV-12069)
3DS indicators will now be processed directly by Evertec instead of Aria. This update improves authentication, error handling, and overall payment processing efficiency.
Client Number Added to Transaction Log for Evertec Smart Payments (DEV-12076)
The client number is now included in the Evertec Smart Payments adapter transaction log output for more efficient troubleshooting. It should be noted that the payment adapter transmits transaction information to Evertec and then receives a response containing the final transaction status.
Learn more about Evertec Smart Payments from here.
Address Validation Added for Avalara Sales and Use Smart Tax(DEV-12161)
For the new Avalara Sales and Use Smart Tax, Aria has added the following two fields to ensure accuracy in tax calculation (Configuration > Integrations > Taxation Configuration > Avalara Sales and Use Smart Tax > Configuration tab):
- Address Validation – This field indicates whether or not the address validation should be processed for the destination contacts, including the Billing Contact.
- Use Updated Avalara Address – This field indicates whether the validated address should be returned by the Avalara Address Validation API and stored in the Aria account.
Address validation is performed for the following countries:
- United States
- Canada
Note: Country eligibility is determined before the validation process. If validation fails or is unsuccessful, the original address provided is used, ensuring uninterrupted processing.
Learn more about Avalara Smart Tax from here.
Cybersource Smart Payments Integration—Phase 1 (DEV-12193)
With this release, Aria now includes the Cybersource payment gateway as part of Aria's Smart Payments integration. Cybersource is a U.S.-based financial technology company providing online payment and fraud management services for small businesses as well as medium and large-sized merchants. Cybersource (with subsidiary Authorize.net) processes payments for almost half a million businesses worldwide.
Aria's Cybersource Smart Payments integration includes the following:
- Customer-Initiated Transactions (CIT) and Merchant-Initiated Transactions (MTI) for the Visa, Mastercard, and Discover card brands
- Fraud detection, ensuring relevant data is sent to Cybersource when fraud scoring is enabled (details below)
- Actions listed in the following table:
| Action | Credit Card (pay method = 1) (VMAD)* | Tokenized Credit Card (pay metod = 13) (VMAD)* |
|---|---|---|
| Payment Authorization | x | x |
| Payment Capture | x | x |
| Payment | x | x |
| Auth Reversal | x | x |
| Refund | x | x |
| Create Token | x | |
| Query Token | x | |
| $0 Authorization | x | |
| Fraud Support | x | x |
*-Visa (001), Mastercard (002), American Express (003) and Discover (004)
UI Configuration Including Fraud Scoring
For the Payment Gateway and Collection Group configuration, the Merchant Account Details tab contains the following fields (for the REST method collection):
| Field | Description |
|---|---|
| Cybersource API Hostname |
This field is a drop down with “Sandbox” or “Production”; based on this option, Aria will use the hostname internally. If you choose “Sandbox”, Aria will use the following: apitest.cybersource.com If you choose “Production”, Aria will use the following to submit the payment request: api.cybersource.com Note: If you are testing in the Stage environment, you can use the “Sandbox” option. If you are using Cybersource Smart Payments in production, you must choose “Production.” Based on the selected option, Aria will send the payment request to the relevant endpoints. |
| Cybersource Merchant ID | This ID is a unique value given to you by Cybersource when creating a merchant with Cybersource. You must provide the merchant ID here so the payment will be attempted for this merchant. |
| Cybersource API Key ID/Cybersource Secret Key | These two fields are used for authenticating the merchant during the payment request. As Cybersource Smart Payments utilize the REST Integration flow, you need to create the Cybersource API Key ID and Cybersource Secret Key from the Cybersource portal and map them to Aria. |
Additionally, The Field Options tab contains the following fields for fraud scoring:
| Field | Description |
|---|---|
| end_user_device_fingerprint | Information from a shopper's device that uses a cobined value to identify the device of the shopper |
| end_user_ip_address | IP address of the customer for which the action is being performed. This value is used for fraud prevention. |
| end_user_browser_agent | User agent of the client's web browser. This can be used for statistical purposes but also to perform anti-fraud checks on transactions. |
Payment Plans Phase 3: Cancellation, Dunning Configuration, and Other Use Cases (DEV-12217)
Phase 3 of Aria Payment Plans delivers key enhancements enabling broader customization and control over payment plans, which improves both administrative and customer experiences. There is now support for different primary and backup payment methods; payment plan cancellation; early payoff options; and advanced dunning configuration. The update also introduces new and improved event notifications, empowers more flexible billing group updates, and streamlines handling of complex use cases such as overpayments and invoice associations.
Note: See the API writeup for this feature.
Payment Plan Details for XML Master File
Aria has added the ability to include payment plan details for the notification methods XML Master File and HTML Email (Notify Method 15) and XML Master File and Text Email (Notify Method 16).
New Replacement Strings
Aria has introduced new replacement strings supporting payment plan overpayments for inclusion on customer statements.
- insertStmtAlignedPaymentPlanRemainingCharge—payment plan charge due
- insertStmtAlignedPaymentPlanRemainingFee—payment plan fee
- insertStmtBaseDebitWithAlignedRemainingInstlAmt—invoice total + aligned payment plan amount and fees without tax + payment plan charge due
- insertStmtTaxesWithAlignedRemainingInstlAmt—invoice total tax charge + aligned payment plan taxes + payment plan tax due
- insertAlignedPymntPlanSeqRemainingAmt—due amount
- insertAlignedPymntPlanSeqAmt—due amount
Support For $0 Charge With Taxes
Aria now supports use cases in which a zero-dollar charge still invokes a taxation charge.
Dunning Configuration for Payment Plans
Client Parameter To Specify Payment Plan Dunning Behavior
Aria has introduced a client-configurable parameter, Dunning Option for Payment Plan, allowing you to customize dunning behavior for failed payment plan collections. Selectable values include:
- Restart Dunning Process—Always restarts dunning from Step 1 when a Payment Plan collection fails.
- Align with invoice due date—Aligns the MPI’s dunning step with the invoice due date.
- Optional—Dunning step customization. You can specify the Dunning plan step customer plans should be placed in when a collection for a payment plan fails:
Note: Contact Aria Support to assign a value for this feature. In a future release, you will be able to define this value directly in the Aria UI.
- -1 (Default): Fully honors due-date-based step alignment.
- 0: Places MPI into the last dunning step.
- 1: Places MPI into (last minus 1) step.
- 2: Places MPI into (last minus 2) step and so on.
Batch Collection Enhancements
Aria's daily collection batch job now attempts payment plan collections against the payment method specified when the payment plan was created, while still honoring billing group payment methods for non-payment-plan charges. If no payment method has been associated with the payment plan, Aria will attempt to collect against the billing group payment method.
New Event in the Accounts and Master Plan Instances Event Class
Aria has introduced a new event, Account Payment Plan Status Changed (Event 763), to the Accounts and Master Plan Instances Event Class.
Updated Failed Collection Event Payload
Aria enhanced the payload for the "failed payment" event (947) in the Financial Transactions event class to include information about the charge transaction against which the attempted payment was to be applied.
PayPal Smart Payments Phase 3 (DEV-12233)
Continuing its Smart Payments integration with the PayPal payment gateway, Aria now supports the following functionality to streamline payment processing:
- Direct Post for 3DS Authorization
- iDEAL-Direct Added as Pay Method
- Webhook Notification Support
- Real-Time Account Updater
- Apple Pay Payments Now Supported
- Transaction Logging for iDEAL-Direct and Apple Pay
Direct Post for 3DS Authorization
Configure the 3DS Notification URL at the Payment Gateway/Collection Account Group (PG/CAG) levels to enable 3DS Authorization via the Direct Post payment handler. Please consult the Internal note below for more information.
iDEAL-Direct Added as Pay Method
Aria now supports iDEAL-Direct as a direct pay method. This is introduced as as pay method 49. Please consult the API ticket here for more information.
PayPal supports Return URL options for ideal payment in which you will be redirected after completing the iDEAL payment. To support this, Aria has introduced the following options (Configuration > Payments > [Payment Gateways/Collection Groups] > Processing Options tab) to configure based on need.
| Field Name | 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 | The alternative URL for transactions cancelled by the customer. |
Webhook Notification Support
Aria has also added the following new UI field for PayPal webhook support (Merchant Account Details tab):
| Field Name | Tooltip |
|---|---|
| Webhook ID | A PayPal-generated Webhook ID is created when a listener URL subscribes to events. Each listener URL has its own unique Webhook ID, which is required for authentication. |
The below four events are honored for iDEAL-Direct (pm=49) payments:
- CHECKOUT.ORDER.APPROVED
- CHECKOUT.ORDER.DECLINED
- PAYMENT.CAPTURE.COMPLETED
- PAYMENT.CAPTURE.DENIED
The “PAYMENT.AUTHORIZATION.VOIDED“ event is honored for CC (pm=1) and TCC (pm=13) authorizations.
Real-Time Account Updater
PayPal provides the Account Updater information as part of real-time API response (i.e payment response). Aria supports the following responses: card expired, token expired, card closed, and token closed. This feature is applicable for Credit Card and Tokenized Credit Card pay methods; currently, PayPal supports the Visa and Mastercard card types.
Apple Pay Payments Now Supported
Aria now supports Apple Pay Payments as part of PayPal's Smart Payments integration. This pay method supports recurring payments and refunds for initial payments outside of Aria (via the record_alternative_payment_m API, the Aria UI, and batch processing; additional API-related details are here).
To configure Apple Pay for PayPal Smart Payments, navigate to the Apple Pay tab (Configuration > Payments > Payment Gateways/Collection Groups [PayPal Smart Payments]). 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 should make an Apple Pay payment outside of Aria to make an encrypted payload and complete payment using the record_alternative_payment_m API (pay method 47 for Tokenized Apple Pay). More information on enabling Apple Pay payments is here.
Additionally, Aria will store shipping contact details from the encrypted payload.
Note: PayPal does not support $0 amounts for Apple Pay transactions.
Transaction Logging for iDEAL-Direct and Apple Pay
Transaction logging support was implemented for the following functionalities:
- iDEAL payment + refund
- Apple Pay initial payment + refund
- Apple Pay recurring payment + refund
Both success and failure scenarios are covered for both supported pay methods. All logging types (FULL, SUMMARY, ERROR, and NONE) are supported. Sensitive data are masked with configurable masking configurations.
CIT/MIT Now Supported for JCB Cards via Chase Paymentech Smart Payments (DEV-12287)
For Chase Paymentech Smart Payments, Japan Credit Bureau (JCB) cards now support flags for Customer-Initiated Transactions (CIT) and Merchant-Initiated Transactions (MIT); these Chase-specific recurring flags will now be sent for transactions via this card type. Please note that JCB cards are processed via Discover by Chase and this applies to U.S. transactions only.
CCP—Additional Payment Methods and Billing Types Now Supported (DEV-12290)
This feature adds three new billing type options for one-time payments in CCP:
- Tokenized Credit Card
- Direct Debit
- Tokenized Direct Debit
Additional actions to the payment method flow in CCP include:
- Add collection group dropdown for adding tokenized credit card as payment method
- Add "Alternate One-Time" to Payment Method options—Tokenized Credit Card (13)
- Add "Alternate One-Time" to Payment Method options—Direct Debit
- Add "Alternate One-Time" to Payment Method options—Tokenized Direct Debit
Learn more about making payments in the Customer Care Portal from here.
Apple Pay Now Supported Through Adyen Smart Payments (DEV-12339)
Aria now supports Apple Pay Payments as part of Adyen's Smart Payments integration. This pay method supports recurring payments and refunds for initial payments outside of Aria (via the record_alternative_payment_m API, the Aria UI, and batch processing).
To configure Apple Pay for Adyen Smart Payments, navigate to the Apple Pay tab (Configuration > Payments > Payment Gateways/Collection Groups [Adyen Smart Payments]). 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 should make an Apple Pay payment outside of Aria to make an encrypted payload and complete payment using the record_alternative_payment_m API (pay method 47 for Tokenized Apple Pay). More information on enabling Apple Pay payments is here.
Additionally, Aria will store shipping contact details from the encrypted payload. Transaction logging is also supported as well as $0 authorizations.
More information on API processing is here.
CCP—View Only Option for Billing Group Details Drawer (DEV-12345)
The Billing Group > Details drawer now has a ‘View Only’ option for users who lack Edit privileges for Billing Groups. Now, when a user who is not permitted Edit privileges selects a Billing Group Name from the Billing Group page, the Details drawer opens in view-only mode. This allows the user access to the billing group information along with its associated subscriptions, but prevents any modifications from being made.
To indicate to the user that they are in view-only mode, a yellow informational panel appears at the top of the Details drawer showing the view-only status as well as guidance on how to obtain the necessary privileges for editing.
Note: The View-Only panel can be dismissed after being read. Dismissing this panel will persist at the account level, meaning it will not reappear for this specific account the next time the unprivileged user views this account’s Billing Group > Details drawer. It will, however, still appear on other accounts.
CCP—Manage Child Accounts Pop-Out Drawer Enhancement (DEV-12346)
Child Accounts can now be updated through a streamlined drawer interface located from the Account > Child Accounts page within CCP. The Update action has been added to the Child Accounts data grid, allowing you to easily view and edit child account details directly from a pop-out drawer. At the top of the drawer, the account number and contact details are displayed. From this drawer, you can change billing responsibilities for subscriptions. Any billing responsibility updates will be instantly reflected on the main Child Accounts page after saving your changes.
Billie Updates (DEV-12349)
Billie
Perform Actions in Aria Billing Cloud
Added the capability to send emails to customer contacts based on a response from Billie.
Conversational UI Features
- Added link to Knowledge Central within Billie CUI for improved user guidance.
- Reworked user feedback system with contextual feedback capture capabilities.
Billie Connect
Infrastructure
Migrated Anthropic Claude Sonnet 3.5 v2 to Anthropic Claude Sonnet v4 for improved performance.
Converse API
Structured response support for "bill comparison" and "estimate next bill" features.
Application Fixes
None
API Features
New API to Retrieve Open Balance Due for Invoice Line Items (DEV-11825)
This feature introduces a new API, get_acct_charges_paid_status_m, to enhance invoice processing. It returns the balance due for each invoice line item in a specified invoice, supporting the identification of eligible services and account-level charges to pay. It also returns details for other unpaid charges and offers filtering options for both pay and unpay operations.
Ability to Configure Default Country For Newly Created Accounts (DEV-11835)
This feature enhances account creation logic to use your default country configuration when none is provided when creating an account via the create_acct_complete_m API, improving accuracy in address and tax calculations. Previously, the system defaulted the new account's country to "US" when you did not pass a value for <country>.
Note: See the application writeup for this ticket for information about configuring countries in your Aria instance.
Plan Update APIs Enhanced With Plan Instance Queue Editing (DEV-12160)
This feature enhances the update_acct_plan_m and update_acct_plan_multi_m APIs to allow you to edit plan instance queues assigned for future activation, making the API consistent with UI capabilities. You can now update fields like Service Location, Destination Contact, Plan Instance Client Defined Identifier, and Description via the API for queued plan instances. A new parameter, <limit_update_to_object_types>, allows you to specify which objects can be updated.
| New Input Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| <limit_update_to_object_types> | array | Limit updates to specific objects only if a plan instance is already queued for a future assignment. | ||||||
|
<limit_update_to_object_types>
|
long |
Governs which fields will be updated. Currently supports Plan Instance and Plan Instance Services, with the flexibility to include additional object types in the future. If multiple fields need to be updated, all corresponding object types can be included in the array. Allowable Values
|
Payment Plans Phase 3: Cancellation, Dunning Configuration, and Other Use Cases (DEV-12217)
Phase 3 of Aria Payment Plans delivers key enhancements enabling broader customization and control over payment plans, which improves both administrative and customer experiences. Aria enhanced the following APIs to support Payment Plan functionality:
- record_external_payment_m
- update_acct_billing_group_m
- create_payment_plan_m
- get_invoice_history_m
- collect_from_account_m
Updates to record_external_payment_m
The record_external_payment_m API now supports Payment Plan details via updated and new input fields.
| Field | Input/Output | Change | ||||||
|---|---|---|---|---|---|---|---|---|
| <specific_installment_message_id> | input | Deprecated | ||||||
|
<specific_installment_message_id>
|
input | Deprecated | ||||||
| <payoff_installment_ind> | input | New description—Indicates if payment should be allocated to payoff future installment or future payment plan due.
Allowable Values
|
||||||
| <specific_message_id_list> (array of <message_id>) | Input | New field—A list of specific email message ID for independent installment due; applicable only when payment application method or default payment collection method is statement First-In-First-Out (FIFO). This provides backward compatibility for <installment_message_id> | ||||||
| <client_payment_plan_id> | Input | New field—Client-defined unique payment plan id. When specified, it will take precedence over other input fields (e.g., <invoice_no> or <statement_no>). | ||||||
| OR | ||||||||
| <payment_plan_no> | Input | New field—Aria-assigned payment plan no. When specified, it will take precedence over other input fields (e.g., <invoice_no> or <statement_no>). |
Notes:
- The new parameters <client_payment_plan_id> and <payment_plan_no> do not support the statement-driven payment application method (method 4), consistent with <specific_charge_transaction_id>, <invoice_no>, and <specific_master_plan_instances_list>.
- When provided, <client_payment_plan_id> or <payment_plan_no> takes precedence over <specific_charge_transaction_id>, <invoice_no>, and <specific_master_plan_instances_list>.
Updates to update_acct_billing_group_m
Aria now supports <recalculate_installment_date> input field in the update_acct_billing_group_m API for payment plans.
Note: This does not support Master Plan Instance bill lag days for Independent Payment Plans.
Updates to create_payment_plan_m
Aria has deprecated the <client_payment_method_id> input field and replaced it with the following parameters:
| New Input Field | Type | Length | Description |
|---|---|---|---|
| <primary_payment_method_no> | long | 22 | Aria-assigned primary payment method no. |
| <client_primary_payment_method_id> | string | 100 | Client-defined unique identifier of the primary payment method. |
| <backup_payment_method_no> | long | 22 | Aria-assigned backup payment method no. |
| <client_backup_payment_method_id> | string | 100 | Client-defined unique identifier of the backup payment method. |
Note: The payment plan must have a primary pay method before you specify backup pay method. When attaching a payment method to a payment plan, please add the collection group for this pay method onto the billing group to which the payment plan belongs to.
Updates to get_invoice_history_m
Added a new true/false input to get_invoice_history_m called <include_payment_plan_info>. If true, the following fields will be returned with info about any payment plans associated with the invoice:
| Output Field Name | Type | Description |
|---|---|---|
| <balance_due> | Balance due amount. | |
| <invoice_payment_plan_info> | array | Array of payment plan information related to an invoice. |
| <payment_plan_create_date> | date | Date when payment plan created. |
| <payment_plan_no> | number | Aria-assigned payment plan no. |
| <client_payment_plan_id> | string | Client-defined unique payment plan ID. |
| <invoice_initial_balance> | float | The invoice initial balance to be paid at the time of payment plan creation. |
| <invoice_paid_amount> | float | The invoice paid amount on a payment plan at the time of the API call. |
| <payment_plan_status> | string | Specifies the other status of payment plan (active, completed, or cancelled). |
Updates to collect_from_account_m
The collect_from_acct_m API now allows you to specify <client_payment_plan_id> or <payment_plan_no> to apply payments to the specified payment plan. You can also specify via the field <payoff_installment_ind> whether the full balance should be paid or only the due amount (default).
PayPal Smart Payments Phase 3 (API)(DEV-12233)
The following payment processing has been enabled for PayPal Smart Payments:
iDEAL-Direct Payments
Once the invoice and statement are generated for the account, you can initiate the iDEAL payment using the record_alternative_payment_m API with the following inputs:
| Input field | Value passed | Comments |
|---|---|---|
| <account_no> | Account Number | |
| <reference_code> | Invoice Number OR some unique identifier value | |
| <payment_amount> | Invoice Amount |
We recommend passing correct invoice amount to make iDEAL payment. We also support $0 amount. |
| <processor_id> | 42 | PayPal Complete processor id |
| <pay_method_type> | 49 | iDEAL Direct Payments method number |
| <statement_no> | Statement Number |
Please follow these steps:
- Once the record_alternative_payment_m API is executed with the above inputs, Aria will return a <payment_redirect_issuer_url>
in the response. You should invoke this <payment_redirect_issuer_url> value in the browser to complete the iDEAL payment (where you are redirected to the issuer/bank page in which they will pass bank details and complete the payment). Once the iDEAL payment is completed, the status of your payment will be updated in Aria via Webhook notification.
Note: PayPal doesn't support recurring payments for the iDEAL pay method.
Apple Pay Payments
While executing the record_alternative_payment_m API, Aria will decrypt the payload, and the decrypted values will be used for completing the intial Apple Pay payment in Adyen, including the following fields:
| Input field | Value passed | Comments |
|---|---|---|
| <account_no> | Account Number | |
| <reference_code> | Invoice Number OR some unique identifier value | |
| <payment_amount> | Invoice Amount |
We recommend passing correct invoice amount to make Apple Pay payment. We also support $0 amount. |
| <processor_id> | 42 | PayPal Complete processor id |
| <pay_method_type> | 47 | Tokenized Apple Pay method number |
| <statement_no> | Statement Number | |
| <external_payment_payload> | External Apple Pay payment payload | encrypted payload received from Apple after authorizing Apple Pay payment via Mac device |
Specify Order of Discount Rules Returned by get_discount_bundle_details_m API (DEV-12239)
This feature enhances the get_discount_bundle_details_m API to return the Discount Rules assigned to a Bundle in the order they were assigned (chronologically) when the <primacy> parameter is set to "true."
Previously, although Discount Rules were ordered correctly within the UI and during Bundle creation, the API would return these rules in rule number order instead of the order defined during creation.
APIs Enhanced to Return Pending Balances (DEV-12259)
Aria has enhanced the APIs get_acct_balance_m and get_acct_details_all_m to provide a detailed breakdown of pending balances, including overdue amounts, helping customers better understand account balances with dynamic payment schedules. Setting the new input parameter <include_acct_past_due_balance> to 1 causes these APIs return the past-due outstanding balance in the field <acct_past_due_balance>.
| New Field | Input/Output | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| <include_acct_past_due_balance> | Input | long | Indicates whether to include outstanding balance on the account that has passed its due date.
Allowable Values
|
||||||
| <acct_past_due_balance> | Output | double | The outstanding balance on the account that has passed its due date. |
Apple Pay Now Supported Through Adyen Smart Payments (API)(DEV-12339)
While executing the record_alternative_payment_m API, Aria will decrypt the payload, and the decrypted values will be used for completing the initial Apple Pay payment in Adyen, including the following fields:
| Input field | Value passed | Comments |
|---|---|---|
| <account_no> | Account Number | |
| <reference_code> | Invoice Number OR some unique identifier value | |
| <payment_amount> | Invoice Amount |
We recommend passing correct invoice amount to make Apple Pay payment. We also support $0 amount. |
| <processor_id> | 34 | Adyen processor id |
| <pay_method_type> | 47 | Tokenized Apple Pay method number |
| <statement_no> | Statement Number | |
| <external_payment_payload> | External Apple Pay payment payload | encrypted payload received from Apple after authorizing Apple Pay payment via Mac device |
API Fixes
- Aria now assigns a dunning status to plan instances added to a Billing Group currently in Dunning via update_acct_plan_multi_m with <rollback_plan_chng_collect_fail> = 0 (meaning "add plan even if collection fails"). Previously, batch job logic both skipped a collection attempt on such a plan as expected (due to BATCH_COLLECT_SKIP_INVOICE_WITH_MPI_IN_DUNNING = TRUE) and also failed to add the plan instance into a dunning status. (TICKET-19844)
WSDL File Locations
Stage Current
Stage Future
Production
Object Query WSDL Files
Stage Current
Stage Future
Production