Instance-Wide Payment Settings
Overview
This is a complete list of payment-related client settings that allow you to specify various behavior options for Aria's payment collections. These include settings related to dunning, updates to payment methods, and when to attempt payment collection for orders.
List of Payment Settings
Getting Here: Configuration > Payments > Payment Settings
| Parameter Name | Default Value | Description |
|---|---|---|
| Accept Ach/Bank Draft | False | Indicates whether or not ACH (Automated Clearinghouse, a.k.a. "Bank Draft") is an acceptable form of payment for this Aria client. |
| Allow Assignment Of "Test" Credit Cards | Allow | Indicates whether or not the Aria system should accept or reject attempts to attach "test" credit card numbers (e.g. "4111111111111111") to accounts. |
| Allow Auto Skip of Next Bill Date | False | When bill lag days is set on a payment method or collection account group, set this parameter to True in order to automatically skip to the next bill date, and get the usage during bill lag day period and the recurring amount due on the next anniversary date. |
| Allow Dunning during payment recovery | FALSE | Determines whether to send MPI to dunning process during payment recovery. If the param is TRUE, notification sends the mpi to dunning, otherwise, MPI skips the dunning process. Default to FALSE. |
| Allow Master Plan Instance Cancellation While Master Plan Instance is in Dunning | Do Not Allow | This governs the Master Plan Instance (MPI) cancellation behavior when an MPI is in dunning. If "Do Not Allow" is selected, the MPI cannot be cancelled (immediately or in the future (including on anniversary)) when the MPI is in Dunning. If "Allow" is selected, the MPI can be cancelled (immediately or in the future (including on anniversary)) when the MPI is in Dunning. The default is "Do Not Allow". |
| Allow Payments Prior to First Invoice and Prior to Previous External Payments | False | Governs the behavior when a payment is received prior to the first invoice. If set to TRUE, the payment will be allowed. Additionally, if set to TRUE, payments will be allowed if they are received prior to previous external payments. If set to FALSE, the payment will fail for those cases. |
| Apply Minimum Collection Threshold to All Collections | False | Governs whether or not the "minimum collection threshold" value, defined at the currency-level, should only be applied to batch collections or all system-wide collections. |
| Auto-Collect On Electronic Form Of Payment Change | True | When billing information for an electronic payment method is updated and there is an outstanding balance, automatically attempt collection. |
| Auto-Collect On Order Invoicing | True | If, when an order is placed, the system automatically generates a separate invoice for that order and an electronic form of payment is used, immediately attempt collection for the order amount (excludes future installment due). |
| Auto-Void Order On Electronic Collection Failure | True | When a call to the "create_order" API is made, and if the client is configured to allow for automatic, immediate electronic collection of order-based invoices, if the collection attempt fails then automatically void the order's associated invoice transaction and mark the order record as cancelled. |
| Default Payment Collection method. | First In First Out (FIFO) | Governs the behavior to employ when a payment is received but the specific application of the payment is unknown. Options are: First-In-First-Out, First-Due-First-Out, Manual (Unapplied Payment) and Statement First-In-First-Out. Statement First-In-First-Out prioritizes payment applied to non-installment charges then installment charges due on that specific statement. API parameters will override this setting. |
| Display Billing Email Address with PayPal Express Checkout transactions | No | Governs the behavior to display the billing email address when PayPal Express Checkout transactions are used. A value of 'Yes' will display the billing email address. A value of 'No' is the default and will not display the billing email address. |
| Dun Plan For Non-Electronic Payment Terms Using Cumulative Past Due Balance | False | Governs whether or not to put plan instances with non-electronic payment terms under a billing group into dunning when the cumulative past due balance is over the dunning minimum threshold. If it’s set as TRUE, ALL plan instances under a billing group will be in dunning when the cumulative past due balance is over the dunning minimum threshold. |
| Dun on Orders for Electronic Payment Methods | False | Governs the behavior to employ when generating an order that is not paid (delinquent) and the Payment Method is electronically collected. The default value of True will cause a delinquent order invoice to result in dunning. A value of False will cause a delinquent order invoice to not result in dunning. |
| Dun on Orders for Non-Electronic Payment Terms | True | Governs the behavior to employ when generating an order that is not paid (delinquent) for Non-Electronic Payment Terms (note that this will also include deprecated Non-Electronic Payment Methods (e.g. Net Terms 30)). The default value of True will cause a delinquent order invoice to result in dunning. A value of False will cause a delinquent order invoice to not result in dunning. |
| Dunning Option for Payment Plan | Restart Dunning | Specifies how dunning behaves when Aria fails to collect the payment plan due amount. By default, Aria restarts the dunning process with Step 1 ('Restart Dunning'). Other option is: 'Align with Invoice Due Date', which places the missed payment plan into the dunning step based on the original invoice date. |
| Enable Refund for NETS Payment | FALSE | Governs whether or not to perform Refund transaction for NETS payment processor |
| Ignore Electronic "Days Till Due" for the create account complete APIs | True | When the "Days Till Due" value is greater than zero for an electronic form of payment (resulting in a delayed collection), governs whether or not to ignore that value when an invoice is generated via the create account complete APIs. |
| Include Credit Memo in Dunning | FALSE | Governs the behavior to include credit memo into dunning consideration. The default value is FALSE which will exclude credit memo from dunning consideration. If it's set as TRUE, credit memo will be included into dunning consideration. |
| NETS Collection Balance | Full Balance | Governs the behavior to employ when collecting balance due and NETS is the payment method. Typically this would only be changed when invoices are billed in advance of the recurring bill cycle (negative bill lag days) such that more than one statement will be generated prior to the first statement being paid in full. |
| Perform Authorization Request on Credit Card Update | True | Governs whether or not to perform a $1 authorization (in whatever currency is applicable) when an account's credit card information is updated. |
| Refund Reversal Action | Reversal | Governs the behavior when refunding payments (and reversing line items) to an end user account holder. In some situations in which a refund is made and taxation of that refund is also required, a rounding of the tax charges can occur resulting in either a positive or net-negative charge. In order to avoid errors, you can use this parameter to rebill and refund instead. If set to rebill, it will cause issue_refund_to_acct_m API and the Refund section of the UI to rebill and refund (provided that line items were not previously reversed as a result of a refund). If set to reverse, it will refund and reverse line items (default). |
| Refund for Proration Credit Action | No Refund - Default | Determines if an eligible refundable payment should be issued an automated refund for 'Cancellation' use case or 'Cancellation or Downgrade' use cases. A payment considered eligible if the payment is fully paid an invoice. If there are more than one (1) payment applied to an invoice or if an attempted refund fails, then an automated refund will not be issued. On 'Refund for Cancellation or Downgrade' option, supported downgrade use cases include: unit of subscription change, a rate tier change, or a subscription change. This parameter acts as an extension of cash credit options ('Produce Cash Credit for Net Negative Amount', 'Produce Corresponding Cash Credit') on 'Net Negative Pro-ration Action' under 'Invoice Setting'. |
| Refundable Payment Maximum Days | 0 | Governs the maximum number of days since a payment (electronic or non-electronic) is posted to be considered as refundable. For an electronic payment that has passed its refundable period, an external refund can be issued. The default value is 0 (existing functionality: max refundable days for non-electronic payment is 365 days and for an electronic payment depends on payment processor refundable period). Best practice is to enter a value greater than payment methods refundable days, or an integer value between 365 to 9999. If a value entered is less than a payment method max refundable day, then it will be ignored. For example, if a value of 200 is entered, the value will be ignored for non-electronic payment as its refundable max day is 365 days, so non-electronic payment older than 200 days but less than 365 days will still be considered as refundable. A valid value is an integer between 0 - 9999, any other value is considered as invalid. |
| Reset Billing Dates On Reprovisioned Status | True | If a plan or account's status is updated after a successful collection (governed via "Reset Plan To Active After Successful Balance Collection"), and it was previously in a non-provisionable status, then reset its billing dates. |
| Reset MPI Status To Active After Successful Balance Collection on Form of Payment Change | Reset the MPI status to active when its current status is any non-active status | If a successful collection is performed after an electronic billing update (governed via "Auto-Collect On Electronic Form Of Payment Change"), and the MPI is in a non-active status (further defined by dropdown choices), set the status to active. |
| Tokenization: Store Full Credit Card | False | When the value is set to 'True' credit card number is stored when creating token. By default this is set to 'False' |
| Use Device ID during Collections | FALSE | Indicates if client's device fingerprint ID is to be passed to payment processor for user verification to further minimize identity fraud. |