Release 6.39

<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.

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).

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.

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).

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).

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.

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.

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.