These release notes contain information about enhancements and fixes to Aria functionality.
Release 6.39
Overview
Production Release Date
10/29/2015
System Requirements
Supported Browsers
- Internet Explorer 9, 10, 11
- Firefox 32
- Chrome 38
- Safari (Mac)
Java Settings
Java 7.0
Screen Resolution
1024 x 768 or higher
User Interface Features
Support for NETS Payments (DEV-5220)
This improvement provides support for NETS as a payment method. As part of this enhancement:
- NETS agreement information and the corresponding Aria account number is returned via a daily NETS batch file. The following actions occur as part of this process:
- If not present, Aria creates a NETS payment method with the agreement information for the account.
- If a NETS payment method is present for the account, then it is updated with the agreement information that is provided in the batch file.
- When a NETS payment method is created during batch processing or is updated with agreement information, if a payment method of type “Other/None” or “External Payment” is used as the primary payment method, then it is replaced with the newly created or updated NETS payment.
Note: If the NETS payment method is already marked as the primary payment method for a billing group, then the account is ready to process payments via NETS as soon as the agreement information for that specific billing group is updated.
- An account may have only one active NETS payment method at a given time. If an account previously had a NETS payment method but it has since been deleted or is no longer active, then a new NETS payment method can be added to the account.
Paymetric Payment Gateway Integration (DEV-5242)
This enhancement integrates the Paymetric payment gateway with Aria. Paymetric supports both one-time and recurring payments.
Supported payment methods include:
- Visa
- MasterCard
- American Express
- Discover
- Tokenized Credit Cards
Supported currencies include:
- U.S. Dollar
- Canadian Dollar
Accessing this Functionality
Getting Here: Click Configuration > Payments > Payments Gateways > New
Rate Schedule Usability Enhancements (DEV-5288)
This enhancement improves the user experience when working with rate schedules. For additional details, refer to the below images.
Previous Layout
The previous layout displayed rate card schedules horizontally, requiring users to scroll to view additional rate cards.
Updated Layout
The updated layout displays rate card schedules vertically. Each rate schedule is initially collapsed until the user selects a rate schedule to view its details. Selecting the star at the top right of a rate schedule makes that the default rate schedule for the plan.
Selecting a rate schedule expands its details:
Direct Post Implementation (DEV-5413)
This feature adds support for Direct Post, which is required for Aria clients who are not PCI compliant and who collect credit card and ACH information from customers as part of the payment process. With Direct Post, Aria’s clients are able to host all payment pages in their Aria‐centered applications with full PCI security compliance because payment information is never seen, processed by, or stored on their systems. Credit card and bank account numbers entered on payment pages pass directly from the customer’s browser to Aria via encrypted post, without the need to host pages on Aria’s PCI compliant infrastructure.
To define a Direct Post configuration in the UI, navigate to Configuration > Client Settings > USS Reg Configuration.
Note: For information about Direct Post APIs, click here.
First Data PayPoint Integration (DEV-5488)
Aria now supports First Data PayPoint as a payment gateway, providing the ability to create, retrieve, and charge a customer using various payment methods in U.S. currency. First Data PayPoint supports the following payment methods:
- Visa
- MasterCard
- American Express
- ACH/E-Check
- Tokenized Credit Cards
Adding First Data PayPoint as a Payment Gateway
Getting Here: Click Configuration > Payments > Payment Gateways
- Click Create New Payment Gateway.
- Select the Payment Gateway drop-down and choose First Data PayPoint from the list.
- Click Save.
The screen loads various fields that allow you to configure the payment gateway.
User Interface Fixes
- UI Help Text Corrected on the Contract Creation Screen (TICKET-9250)
- Payment Method Drop-Down Failed to Display Payment Methods That Were Not Associated with a Billing Group (TICKET-9492)
- Renewed Contracts Failed to Display in the UI and Failed to Return in APIs (TICKET-9747)
API Enhancements
Blacklisting Existing Encrypted Credit Cards (DEV-5364)
This enhancement introduces the update_cc_blacklist_m API, providing the ability to add an existing account number and payment method to the credit card blacklist stored in Aria. The following update_cc_blacklist_m API input parameters are now available:
- <cc_num>
- <acct_no>
- <client_acct_id>
- <credit_card_payment_methods>
- <payment_method_no>
- <client_payment_method_id>
Note: If no payment method inputs are provided, all non-disabled credit cards associated with the specified account will be added to the blacklist.
Payment Indicator Output Added to get_accts_with_existing_pay_methods (DEV-5408)
This improvement adds a new output parameter to the get_accts_with_existing_pay_methods API. The new <active> output parameter indicates that an electronic payment type is currently the primary active method for the account.
A returned value of 1 indicates that:
- the electronic payment is set as the primary payment method for the account.
- at least one billing group’s primary payment method matches the specified electronic payment value.
A returned value of 0 indicates that:
- the electronic payment is not the primary payment method for the account.
- a billing group is not active.
Direct Post API Implementation (DEV-5413)
In addition to defining a Direct Post configuration in the UI, you can create a Direct Post configuration using the set_reg_uss_config_params API. The only required parameter for this call is <redirecturl>, which is the URL to which Aria returns the online customer. It is important to specify the <redirecturl> parameter for each application that uses Direct Post.
set_reg_uss_config_params API Parameters
The table below describes the available set_reg_uss_config_params API parameters:
Parameter |
Required? |
Expected Values |
Description |
---|---|---|---|
<redirecturl> |
Yes |
Valid URL |
The URL you wish Direct Post to immediately redirect to once it has processed payment information. It should be capable of performing error handling based off of potential error messages that Direct Post can return, or print a “receipt page” (or some other type of success page) if there are no returned errors. |
<do_one_time_collection> |
No |
1/0 |
This is a User Self-Service feature that requires a form input field named <collection_amount> in order to work. This should only be used in conjunction with Credit Card and ACH (Automated Clearing House) forms. Net Terms is not supported. If this parameter is set to True (1), collection is performed using the amount entered in the <collection_amount> form field (or if blank using the account balance), with the entered Credit Card or ACH information. The form of payment on file will not be changed. Direct Post expects that a positive numeric value be entered in the <collection_amount> field. If set to True (1), this takes priority over all other directives. By default, <do_one_time_collection> is set to True (1). Payment is processed at the account level and applied to open charge transactions in a FIFO manner. |
<min_cc_auth_threshold>
|
No |
Monetary Unit |
This is the minimum transaction amount above which credit card authorization should occur. For instance, if it is desired that a minimum $10 transaction occur before authorizing an electronic payment, set this to 10. This threshold will be honored for authorizations performed regardless of whether <do_combined_auth_and_collect> is set to True or False. By default, <min_cc_auth_threshold> is set to 1. |
<do_cc_auth_full_amount> | No | 1/0 |
This parameter determines whether a full authorization or a $0 authorization will be performed for credit card payment methods. By default, <do_cc_auth_full_amount> is set to False (0). |
<min_collect_threshold> | No | Monetary Unit |
This is the minimum transaction amount above which collections should occur. For instance, if it is desired that at least $10 of transactions occur before collecting an electronic payment, set this value to 10. By default, <min_collect_threshold> is set to 1. |
<do_combined_auth_and_collect> | No | 1/0 |
This parameter determines whether or not to perform both an authorization and collection when a credit card is provided. Note that the <min_collect_threshold> will be honored for all collection attempts. In cases where the amount to be collected falls below the <min_collect_threshold>, no collection will be performed. By default, <do_combined_auth_and_collect> is set to True (1). |
<change_mp_status_on_success> | No | 1/0 |
This parameter acts as a flag that indicates that the master plan instance status should be changed if a successful collection and/or authorization was performed as part of the Direct Post process. If changing the Master Plan Instance status is not desired, set it to False (0). By default, <change_mp_status_on_success> is set to False (0). |
<mp_status_on_success> | No | Valid Aria Master Plan Instance Status |
This parameter should only be set if <change_mp_status_on_success> is set to True (1). This must be a valid Master Plan Instance status code. By default, <mp_status_on_success> is null. |
<change_mp_status_on_failure> | No | 1/0 |
This parameter acts as a flag that indicates that the Master Plan Instance status should be changed if the collection or authorization performed as part of the Direct Post process failed. If changing the Master Plan Instance status is not desired, set it to False (0). By default, <change_mp_status_on_failure> is set to False (0). |
<mp_status_on_failure> |
No |
Valid Aria MPI status code |
This parameter should only be set if <change_mp_status_on_failure> is set to True (1). This must be a valid Master Plan Instance status code. By default, <mp_status_on_failure> is null. |
<disable_pmt_method_on_failure> |
No |
1/0 |
By default, the payment method provided via Direct Post will be saved as an active payment method on the account in Aria. This parameter determines whether or not in cases where the collection or authorization fails, the payment method will remain as an active payment method on the account, in which case it will be available for future use. Set to True (1) for payment methods to be disabled in cases of authorization or collection failures, in which case the payment method will not be available for future use. By default, <disable_pmt_method_on_failure> is set to False (0). |
<save_as_cc_token> |
No |
1/0 |
This parameter refers to payments made via credit cards or debit/check cards that are processed as credit cards, and where the card number is stored as a token by the processor. By default, <save_as_cc_token> is set to False (0). |
<kill_dp_session> |
No |
1/0 |
If this parameter is set to True (1), Direct Post calls the kill_session API method, which disables the current session ID after Direct Post has completed its transactions successfully or unsuccessfully. After the session ID is disabled, you must call set_session or set_session_auth again to start a new session if you wish to reattempt any unsuccessful transactions. This will allow you to verify the validity of a session every time a customer resubmits payment information. In addition, disabling a session ID will prevent that session ID from being used for any transactions other than the ones triggered by Direct Post in your Account Registration or User Self Service application. This field is set to False (0) by default. This allows the same session to be reused if a customer attempts to resubmit payment information. Note: If you call the set_session or set_session_auth API method for something other than Direct Post and you want to utilize the <kill_dp_session> field, you will need to call a separate instance of set_session or set_session_auth specifically for Direct Post. For example, if you set up the <kill_dp_session> to automatically disable a session ID, then when Direct Post attempts to authorize a credit card and the authorization fails, the session ID is disabled. You must then call set_session again to start a new session and allow the customer to resubmit credit card information. |
<alt_client_acct_group_id> |
No |
Your chosen Client Group ID |
This parameter refers to a Client Group ID, which is a unique ID code with which to identify a collection account group. A Client Group ID is added when creating or editing a collection account group in Aria. Set this field to your chosen Client Group ID to specify that for a payment that you are currently submitting to Direct Post, Aria should process the transaction using the payment gateway information associated with the corresponding collection account group instead of the default Aria collection account group or the collection account group to which a customer is assigned. Note: Passing the <alt_client_acct_group_id> parameter will not assign a customer to the corresponding collection account group. Unless you specify otherwise, future payments will be processed using the default Aria collection account group or the collection account group to which a customer is assigned. By default, <alt_client_acct_group_id> is null. |
New set_session_m API
The set_session API method is called by a client-hosted server side process upon successful authentication of the customer via a client-hosted web site.
set_session_m API Inputs
Field Name |
Field Type |
Required? |
Description |
---|---|---|---|
<alt_caller_id> |
string |
No |
The value of the <alt_caller_id> provided with this API call will automatically be used as the <alt_caller_id> for all API calls made by Direct Post for the session. |
<application_id> |
string |
No |
The identifier of the application calling this API (example: “Salesforce”). The value of the <application_id> provided with this API call will automatically be used as the application_id for all API calls made by Direct Post for the session. |
<application_date> |
string |
No |
The application date/timestamp for tracking when the application called this API. For example: 01/01/2014 10:00:00 The value of the <application_date> provided with this API call will automatically be used as the <application_date> for all API calls made by Direct Post for the session. |
set_session_m API Outputs
Field Name |
Field Type |
Length |
---|---|---|
<session_id> |
string |
32 |
<error_code> |
long |
32 |
<error_msg> |
string |
32 |
API Override of Proration Invoice Timing (DEV-5489)
This feature enhances plan assignment and updates APIs to include an override for the Proration Invoice Timing configuration option as defined in the product catalog. The Proration Invoice Timing setting determines when to create a separate invoice for prorated charges. The available settings include:
- Immediately
- Defer to the Next Anniversary Date
To invoice immediately in cases where proration would appear on the next anniversary invoice, call these APIs with <do_write> set to false and the invoice timing override set to Immediately.
New Input Parameters Added to APIs
A new input parameter–<proration_invoice_timing>–is now available in the following APIs to provide the ability to override the proration invoice timing configuration setting that is saved with a plan in the product catalog:
- assign_acct_plan_m
- update_acct_plan_m
- replace_acct_plan_m
- cancel_acct_plan_m
The allowed values for <proration_invoice_timing> are as follows:
- Null (default) - Honors the Proration Invoice Timing configuration saved with the plan in the product catalog.
- 0 - Invoices immediately.
- 1 - Invoices on next anniversary date.
A new input parameter–<mp_proration_invoice_timing>–is now available in the update_acct_complete_m API to provide the ability to override the Proration Invoice Timing configuration setting that is saved with a plan in the product catalog.
The allowed values for <mp_proration_invoice_timing> are as follows:
- Null (default) - Honors the Proration Invoice Timing configuration saved with the plan in the product catalog.
- 0 - Invoices immediately.
- 1 - Invoices on next anniversary date.
SDKs Now Available
SDKs are now available on the SDK Downloads page. Each SDK collection includes both classes.
API Fixes
- The update_acct_unit_instance API Saved Changes to Plan Unit Instances When <do_write=false> (TICKET-9330)
- Allowable Values Updated for the create_acct_complete_m API (TICKET-9440)
- Allowable Values Failed to Display for the <nso_bill_immediately> Parameter (TICKET-9619)
- The get_client_plans_all_m API Failed to Return an NSO Currency Code When an Individual NSO Item Was Bundled With a Plan (TICKET-9856)
WSDL File Locations
Stage Current
US | |
EUR | None |
Stage Future
US |
https://secure.future.stage.ariasystems.net/api/Advanced/wsdl/6.39/complete-doc_literal_wrapped.wsdl |
EUR |
Production
US |
https://secure.ariasystems.net/api/Advanced/wsdl/6.39/complete-doc_literal_wrapped.wsdl |
EUR |
https://secure.prod.cph.ariasystems.net/api/Advanced/wsdl/6.39/complete-doc_literal_wrapped.wsdl |
Object Query WSDL Files
Stage Current
US | |
EUR | None |
Stage Future
US | |
EUR |
Production
US |
https://secure.ariasystems.net/api/AriaQuery/wsdl/6.37/integration_services-doc_literal_wrapped.wsdl |
EUR |