Create Direct Post Configuration

Last updated
Save as PDF

Overview

You can create a Direct Post configuration set that defines actions to be taken on an account when a customer performs payment-related transactions in your registration or user self-service (USS) application.

Instructions

To define a Direct Post configuration in the Aria application, navigate to Configuration > Client Settings > USS Reg Configuration > New Direct Post. Then configure the fields as described below:

Set Name: Name of the collection of Direct Post configuration values you are entering on this screen.

Set Description: Description of the collection of Direct Post configuration values you are entering on this screen.

Redirect URL: This is a URL to which the Direct Post Handler immediately redirects once it has processed payment information. It must be capable of performing error handling based on the potential error messages that the Direct Post Handler can return, or capable of printing a "receipt page" (or some other type of success page) if there are no returned errors.

One Time Collection: A user self-service (USS) feature that uses a form input field called “collection_amount”. If an amount is not provided, the account balance is collected. Only use this field in conjunction with credit card and ACH forms. The net terms payment method is not supported, so any form of net terms should not be selectable on this type of payment page. If this is set to True, collection is performed using the amount entered in the “collection_amount” form field (or if blank, the entire account balance), with the entered credit card or ACH information. Form of payment on file is not changed. There must be a positive numeric value entered in the “collection_amount” field. If set to True, this takes priority over all other directives, which are not used. Payment is processed at the account level and applied to open charge transactions in a first in, first out (FIFO) manner.

Minimum Credit Card Authorization Threshold: Minimum transaction amount above which credit card authorization must occur. For instance, if you want a minimum $10 balance before authorizing an electronic payment, set this to 10. This threshold is honored for authorizations performed regardless of whether Perform Both Authorizations and Collections for Credit Cards is set to True or False. If not specified, a minimum authorization threshold of 1 is used.

Note: To ensure that your collection group settings (under Configuration > Payments > Collection Groups > New or Existing > System Overrides section) related to $0/1 authorizations are honored:

Set the Perform Authorization Request on Credit Card Update parameter to True (under Configuration > Payments > Payment Settings).
Set the Minimum Card Authorization Threshold to a value other than 0.

Use Full Amount When Authorizing Credit Cards: Determines whether a full authorization or a $0 authorization is performed for credit card payment methods. Note that Minimum Credit Card Authorization Threshold is honored for both full authorizations and $0 authorizations.

Minimum Collection Threshold: Minimum balance amount above which collections occur. For instance, if you want at least $10 of transactions to occur before collecting an electronic payment, set this to 10. If not specified, a minimum collection threshold of 1 is used.

Perform Both Authorizations and Collections for Credit Cards: Determines whether to perform both an authorization and collection when a credit card is provided. Note that the Minimum Collection Threshold is honored for all collection attempts, so in cases where the amount to be collected falls below the Minimum Collection Threshold, no collection is performed.

Change Master Plan Instance Status on Success: Indicates that the Master Plan Instance status is changed if the collection or authorization performed as part of the Direct Post process succeeds. Set it to False if you do not want to change the Master Plan Instance status.

Master Plan Instance Status on Success: If Change Master Plan Instance Status on Success is set to True, select the desired status of the Master Plan Instance(s). See Master Plan Status Codes for a description of Plan statuses.

Change Master Plan Instance Status on Failure: Indicates that the Master Plan Instance status is changed if the collection or authorization performed as part of the Direct Post process fails. Set it to False if you do not want to change the Master Plan Instance status.

Master Plan Instance Status on Failure: If Change Master Plan Instance Status on Failure is set to True, select the desired status of the Master Plan Instance(s). See Master Plan Status Codes for a description of Plan statuses.

Disable Payment Method on Failure: By default, the payment method provided using Direct Post is saved as an active payment method on the account in Aria. In cases where the collection or authorization fails, this parameter determines whether the payment method remains as an active payment method on the account, leaving it available for future use. Set this to True to disable payment methods in cases of authorization or collection failures, making the payment method unavailable for future use.

If you enabled fraud scoring/filtering in your Direct Post configuration, you can use this field to also specify whether to disable or enable a payment method after fraud scoring/filtering failure (if your payment gateway supports fraud scoring/filtering).

Note: In order for a payment method to be disabled as described above, you must specify an amount in the Minimum Collection Threshold field.

Change Master Plan Instance Status on Collection not Attempted: Indicates whether the Master Plan Instance status should be changed if a collection is not attempted. Set it to False if you do not want to change the status of the Master Plan Instance(s).

Master Plan Instance Status on Collection not Attempted: If Change Master Plan Instance Status on Collection not Attempted is set to True, select the desired status of the Master Plan Instance(s). See Master Plan Status Codes for a description of Plan statuses.

Save Card as Token: For payments made using credit cards or debit/check cards that are processed as credit cards, this flag indicates whether the card number is stored as a token by the payment gateway.

Kill Direct Post Session: If this field is set to True, Direct Post calls the kill_session_m API method, which disables the current session ID after Direct Post has completed its transactions, either successfully or unsuccessfully. After the session ID is disabled, you must call set_session_m or set_session_auth_m again to start a new session if you want to retry any unsuccessful transactions. This allows you to verify the validity of a session every time a customer resubmits payment information. In addition, disabling a session ID prevents 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. If this field is set to False, the Direct Post session is not killed. This allows the same session to be reused if a customer attempts to resubmit payment information.

Note: If you call the set_session_m or set_session_auth_m API method for something other than Direct Post and you want to utilize the <kill_dp_session> field, you must call a separate instance of set_session_m or set_session_auth_m specifically for Direct Post. For example, if you set up the <kill_dp_session> to automatically disable a session ID, when Direct Post attempts to authorize a credit card and the authorization fails, the session ID is disabled. You must then call set_session_m again to start a new session and allow the customer to resubmit credit card information.

Alternative Client Group ID: Specifies the Client Group ID, a unique ID code that identifies a collection group. You add a client group ID when you create or edit a collection group in Aria. This ID specifies that, for the current payment, Aria processes the transaction using the payment gateway information associated with the corresponding collection group. This collection group is used instead of the default Aria collection group or the collection group to which a customer is assigned.

Note: Using this field does not assign a customer to the corresponding collection group. Future payments will be processed using the default Aria collection group or the collection group to which a customer is assigned.

Perform ACH Collection: Indicates whether to collect a payment when the customer provides bank account details.

Note: Aria will honor your specified minimum collection threshold for all collection attempts. When the amount to be collected is below the minimum collection threshold, Aria will not collect a payment.

Notes about fraud protection:

The fraud protection features described below are available to you if your payment gateway supports them.
To use fraud protection features, you must have them enabled and configured with your payment gateway.
Contact your payment gateway representative for setup information and additional documentation.
If you are using Direct Post and you are running a $0 authorization, then Aria will skip any steps in your configuration that involve fraud scoring, fraud filtering, or 3D Secure authorization.

Fraud Scoring Enabled: Indicates whether to send a request to your payment gateway for a fraud score. If you set it to False, then all other fraud scoring fields will be disabled.

Fraud Scoring Threshold: Allows you to set a threshold that your payment gateway will use to determine a fraud score as a numeric value. If the payment processor returns a non-numeric fraud score response, Aria will ignore the threshold that you entered.

Change MP Status on Fraud Scoring Failure: Indicates whether to change the status of the Master Plan Instance(s) if the fraud scoring request returns a failure response. Set it to False if you do not want to change the status.

MP Status on Fraud Scoring Failure: If Change MP Status on Fraud Scoring Failure is set to True, select the desired status of the Master Plan Instance(s). See Master Plan Status Codes for a description of Plan statuses.

Change MP Status on Fraud Scoring Review: Indicates whether to change the status of the Master Plan Instance(s) if "review" was returned as part of the fraud score result. Set it to False if you do not want to change the status.

MP Status on Fraud Scoring Review: If Change MP Status on Fraud Scoring Review is set to True, select the desired status of the Master Plan Instance(s). See Master Plan Status Codes for a description of Plan statuses.

Fraud Filtering Enabled: Indicates whether to send a request to your payment gateway for fraud filtering information. If you set it to False, then all other fraud filtering fields will be disabled.

Change MP Status on Fraud Filtering CC Prefix Failure: Indicates whether to change the status of the Master Plan Instance(s) if the purchase transaction failed the fraud filtering check for the credit card prefix. Set it to False if you do not want to change the status.

MP Status on Fraud Filtering CC Prefix Failure: If Change MP Status on Fraud Filtering CC Prefix Failure is set to True, select the desired status of the Master Plan Instance(s). See Master Plan Status Codes for a description of Plan statuses.

Change MP Status on Fraud Filtering CC Number Failure: Indicates whether to change the status of the Master Plan Instance(s) if the purchase transaction failed the the fraud filtering check for the credit card number. Set it to False if you do not want to change the status.

MP Status on Fraud Filtering CC Number Failure: If Change MP Status on Fraud Filtering CC Number Failure is set to True, select the desired status of the Master Plan Instance(s). See Master Plan Status Codes for a description of Plan statuses.

Change MP Status on Fraud Filtering CC Issuing Country Failure: Indicates whether to change the status of the Master Plan Instance(s) if the purchase transaction failed the fraud filtering check for the credit card issuing country. Set it to False if you do not want to change the status.

MP Status on Fraud Filtering CC Issuing Country Failure: If Change MP Status on Fraud Filtering CC Issuing Country Failure is set to True, select the desired status of the Master Plan Instance(s). See Master Plan Status Codes for a description of Plan statuses.

Change MP Status on Fraud Filtering CC Issuing Country Suspect: Indicates whether to change the status of the Master Plan Instance(s) if the fraud filtering check for the credit card issuing country returned a "suspect" value. Set it to False if you do not want to change the Master Plan Instance status.

MP Status on Fraud Filtering CC Issuing Country Suspect: If Change MP Status on Fraud Filtering CC Issuing Country Suspect is set to True, select the desired status of the Master Plan Instance(s). See Master Plan Status Codes for a description of Plan statuses.

Marketing Insights: Indicates whether to return marketing information, if your payment gateway supports that feature and you configured it with your gateway and in Aria. Select Use Client Defined Settings to use your settings specified at the payment gateway or collection group level. Select Do Not Return if you do not want to have marketing information returned. Select Return if you want to have marketing information returned. See Support for Vantiv Insights Marketing Tools for more information about marketing insights.

Perform balance inquiry: Indicates whether to obtain a balance inquiry that reflects the remaining balance for pre-paid cards and gift cards. This feature is available to you if your payment gateway supports it and you configured it with your gateway and in Aria. Select True to obtain the remaining balance for pre-paid cards and gift cards. Select False if you do not want to obtain the remaining balance for pre-paid cards and gift cards. See New Payment Method: Merchant Specific Gift Card for more information about the gift card payment method.

Transaction Type: If you use Chase Paymentech, you can use this field to tell that payment gateway which transaction type is involved when you process a customer's payment information. This field applies to cards and tokenized credit cards. If you leave this field blank it will default to Use Client Configuration Settings.

Notes:

The value that you pass into this field will override the Recurring Options that you set in the Aria application under:
- Configuration > Payments > Payment Gateways > Chase Paymentech > Gateway Options; and
- Configuration > Payments > Collection Groups > Chase Paymentech > Collection Group Options.
Currently, only Chase Paymentech supports this field. Other payment gateways might not honor all of the available values for this field. You will need to check your payment gateway documentation for confirmation.

Aria will use this order of precedence to determine the transaction type:

value selected for this field
collection group configuration
payment gateway configuration.

Perform DD Collection: If your payment gateway supports the Direct Debit payment method, set this field to True to collect a payment made using Direct Debit. Then complete the additional steps described in Use Direct Post to Collect Direct Debit Payments.

SCA Exemption: For Chase Paymentech, the low value payment exemption for strong customer authentication (SCA) exemption for 3DS-enabled merchants can be implemented using a Direct Post configuration. This is in support of the Visa ^®, Mastercard ^®, and International Maestro ^® card types.

The allowed values at the SCA Exemption field are as follows:

Value	Description
-1	Use client configuration CG/PG settings for determining the exemption type.
0	This value will prefer to perform 3ds authorization steps (3ds challenge) for transaction.
1	This value will prefer to skip the 3ds authorization steps for transaction and this forms the SCA-exempted transaction.

Save Direct Debit as Token: This has been added in support of Tokenized Direct Debit transactions for the Stripe payment gateway (for the SEPA and BACS payment methods). Select one of the following values at this field:

Value	Description
True	When the Direct Post setting “Save Direct Debit as Token“ is set to True, then the given direct debit details will be sent with the Tokenized Direct Debit payment method (37), the payment is processed with the TDD payment method, and token information is stored in the payment method of the account.
False (default)	When the Direct Post setting is configured with “Save Direct Debit as Token“ as false or null, then the given direct debit details will be sent with the Direct Debit payment method (26), the payment is processed with the DD payment method, and the actual bank information is stored in the payment method of the account.

BACS (Bankers Automated Clearing Services) is a UK bank-to-bank payment method. SEPA (Single Euro Payments Area) is a payment scheme used for local Euro bank-to-bank transfers across Europe.

Honor BG Collection Group: When this is enabled, the Direct Post will check for the Billing Group's Collection Group and use it at the time of the collection attempt.

Value	Description
Empty/False (default)	To maintain backward compatibility for our existing clients, the collection will be attempted with either the <alt_collection_group> API input if provided or the account’s collection group.
True	The collection will be attempted with the Billing Group's Collection Group.