Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo Documentation > Direct Post Payment Handler > Create a Configuration Set with the set_reg_uss_config_params_m API

Create a Configuration Set with the set_reg_uss_config_params_m API

This article applies to:Aria Crescendo

 

Use the set_reg_uss_config_params_m API call to 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.

If you do not have a Payment Card Industry (PCI)-compliant infrastructure, you will need to use Direct Post. You can pass values into the additional fields described below that specifically apply to Direct Post.

Notes:

  • Fraud-related inputs passed to this API call will override any fraud options that you specified in your payment gateway or collection group, unless stated otherwise below. 
  • You cannot obtain the fraud score for credit or debit cards enrolled in 3D Secure.
  • If 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.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client calling the API.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png set_name string 100

Client-defined identifier for this configuration set.

The set_name parameter must comply with the following format:

  • The set name prefix must be “direct_post_
  • The set name suffix can be any combination of alphanumeric characters. As a best practice, the suffix should relate to your hosted application in some way. For instance, your registration configuration set name could be direct_post_registration or direct_post_reg. Your user self‐service configuration set could be called direct_post_uss or what makes sense to you from a coding perspective.
  set_description string 1000 The description to be used for a newly-created configuration set
  set_type_no long 100

Use the set type number to identify a configuration set as being generic or for Direct Post.

You will see your specified type of configuration set in the Set Type column in Aria under Configuration > Client Settings > USS Reg Configuration.

The default value is 1 (generic).

Allowable Values
in_reg_uss_config_params array   Your chosen Direct Post configuration parameters passed as an array of param_name/param_val key-value pairs. The allowable fields and values for the key-value pairs are listed below.
  param_name Field Type Max Length

param_val:

  • Field Type: string
  • Max Length: 3000
redirecturl string 3000 This is a URL to which the Aria-hosted Direct Post Handler immediately redirects once it has processed payment information. It must be able to perform error handling based on potential error messages the Direct Post Handler can return, or able to display a “receipt page” (or some other type of success page) if there are no returned errors. You must specify the redirecturl for each application that uses Direct Post.
  do_one_time_collection string 3000

This is a user self-service feature that requires a form field named collection_amount.

If this is set to 1 (true):

  • Direct Post calls collect_from_account_m using the amount entered in the collection_amount form field, with the entered credit card or ACH information. If no collection_amount is provided, then the sum of the amount due for all invoice numbers provided will be collected (see pending_invoice_no and full_invoice_no). If no invoice numbers are provided, then the sum of the balances for all MPI (master plan instance) IDs provided will be collected (see master_plan_instance_no and client_master_plan_instance_id). If no MPI IDs are provided, the account balance will be collected.
  • This takes priority over all other directives (including min_collect_threshold), which will not be used.

The collection amount must be a positive numeric value to be entered in the collection_amount field.

The form of payment on file is not changed. The payment will be processed at the account level and applied to open charge transactions in a FIFO (first-in, first-out) manner.

You can use this field only with credit card and Automated Clearing House (ACH) forms of payment. Net terms is not supported, so any net terms form of payment must not be selectable on a payment page that contains this field.

By default, do_one_time_collection is set to 1 (true).

Note: This parameter applies only to USS Direct Post configurations. If you need more functionality, you can use the collect_from_account_m API. You can call this API for both USS and registration use cases, and it also allows you to use an alternate payment method.

Allowable Values
  pending_invoice_no string 3000

The Aria-assigned number of the pending invoice(s) for which a payment should be collected.

If authorization or collection is successful, then the payment method provided in the Direct Post form will be saved as the primary payment method for all billing groups on the account that are associated with the  invoice(s) provided.

Notes:

  • One of the following fields is required only when the do_one_time_collection parameter is set to 0 (false): pending_invoice_no OR full_invoice_no OR master_plan_instance_no OR client_master_plan_instance_id. The fields mentioned above will be evaluated in the order in which they are listed.
  • If the do_one_time_collection parameter is set to 1 (true), the amount of any pending invoice(s) provided will be used to determine the collection amount in addition to any amount specified in the  collection_amount form field (see do_one_time_collection).
  • If multiple pending invoices are provided, there will be separate collection attempts – one for each pending invoice specified.
  full_invoice_no string 3000

The Aria-assigned number of the non-pending invoice(s) for which a payment should be collected.

If authorization or collection is successful, then the payment method provided in the Direct Post form will be saved as the primary payment method for all billing groups on the account that are associated with the  invoice(s) provided.

Notes:

  • One of the following fields is required only when the do_one_time_collection parameter is set to 0 (false): pending_invoice_no OR full_invoice_no OR master_plan_instance_no OR client_master_plan_instance_id. The fields mentioned above will be evaluated in the order in which they are listed.
  • If the do_one_time_collection parameter is set to 1 (true), the amount of any full invoice(s) provided will be used to determine the collection amount in addition to any amount specified in the  collection_amount form field (see do_one_time_collection).
  • If multiple invoices are provided, there will be only one collection attempt for the combined amount due for all invoices specified.
  master_plan_instance_no string 3000

The Aria-assigned number of the master plan instance(s) (MPIs) for which the payment is being collected.

If authorization or collection is successful, then the payment method provided in the Direct Post form will be saved as the primary payment method for all billing groups on the account that are associated with the MPIs provided.

Notes:

  • One of the following fields is required only when the do_one_time_collection parameter is set to 0 (false): pending_invoice_no OR full_invoice_no OR master_plan_instance_no OR client_master_plan_instance_id. The fields mentioned above will be evaluated in the order in which they are listed.
  • If the do_one_time_collection parameter is set to 1 (true), the amount of any MPIs provided will be used to determine the collection amount in addition to any amount specified in the  collection_amount form field (see do_one_time_collection).
  • There will be only one collection attempt for the combined total of the MPIs specified.
  client_master_plan_instance_id string 3000

The client-defined identifier for the master plan instance(s) (MPIs) for which the payment is being collected.

If authorization or collection is successful, then the payment method provided in the Direct Post form will be saved as the primary payment method for all billing groups on the account that are associated with the MPIs provided.

Notes:

  • One of the following fields is required only when the do_one_time_collection parameter is set to 0 (false): pending_invoice_no OR full_invoice_no OR master_plan_instance_no OR client_master_plan_instance_id. The fields mentioned above will be evaluated in the order in which they are listed.
  • If the do_one_time_collection parameter is set to 1 (true), the amount of any MPIs provided will be used to determine the collection amount in addition to any amount specified in the  collection_amount form field (see do_one_time_collection).
  • There will be only one collection attempt for the combined total of the MPIs specified.
  min_cc_auth_threshold string 3000

This is the minimum transaction amount necessary before credit card authorization occurs.  For instance, if you want a minimum $10 transaction to occur before authorizing an electronic payment, set this field to 10.  min_cc_auth_threshold takes precedence over min_cc_auth_threshold as described below.

By default, the min_cc_auth_threshold parameter is set to 1.

  do_cc_auth_full_amount string 3000

Determines whether a full authorization or a $0 authorization is performed for credit card payment methods.

Set it to 1 (true) to perform a full authorization.

By default, do_cc_auth_full_amount is set to 0 (false) and a $0 authorization is performed.

Note: min_cc_auth_threshold takes precedence over min_cc_auth_threshold. Example: if you set min_cc_auth_threshold to 10 and the transaction amount is $9, then no credit card authorization is performed regardless of what you pass into do_cc_auth_full_amount.

Allowable Values
  min_collect_threshold string 3000

This is the minimum transaction amount above which collections occur. For instance, if you want at least $10 of transactions to occur before collecting an electronic payment, set this field to 10.

By default, min_collect_threshold is set to 1.

  do_combined_auth_and_collect string 3000

Determines whether to perform both an authorization and collection when a credit card is provided.

Note: min_collect_threshold is honored for all collection attempts, so in cases where the amount to be collected falls below the min_collect_threshold, no collection is performed.


The default for this field is 1 (true).

Allowable Values
  change_mp_status_on_success string 3000

This field indicates that the master plan instance status changes if a collection and/or authorization succeeds as part of the Direct Post process.

Set it to 0 (false) if you do not want to change the master plan instance status.

The default for this field is 0 (false).

Allowable Values
  mp_status_on_success string 3000

Set this value only if change_mp_status_on_success is set to 1 (true). This value must be a valid Aria master plan instance status code

The default for this field is null, which means that the master plan instance status will not be changed.

  change_mp_status_on_failure string 3000

This field indicates that the master plan instance status changes if a collection and/or authorization fails as part of the Direct Post process.

Set it to 0 (false) if you do not want to change the master plan instance status.

The default for this field is 0 (false).

Allowable Values
  mp_status_on_failure string 3000

Set this value only if change_mp_status_on_failure is set to 1 (true). This value must be a valid Aria master plan instance status code

The default for this field is null, which means that the master plan instance status will not be changed.

  disable_pmt_method_on_failure string 3000

By default, the payment method provided via Direct Post is saved as an active payment method on the account in Aria. This parameter determines, in cases where the collection or authorization fails, if the payment method remains in an active status on the account, making it available for use in the future.

Set this to 1 (true) to disable the payment method in cases of authorization or collection failure. This makes the payment method unavailable for future use.

The default for this field is 0 (false).

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

 

Allowable Values
  change_mp_status_on_collection_not_attempted string 3000

Indicates whether the master plan instance status should be changed if a collection is not attempted.

Set it to 0 (false) if you do not want to change the status of the master plan instance(s).

Allowable Values
  mp_status_on_collection_not_attempted string 3000 If change_mp_status_on_collection_not_attempted is set to 1 (true), select the desired status of the master plan instance(s). See Master Plan Status Codes for a description of plan statuses.
  save_as_cc_token string 3000

This field indicates whether payments made using credit cards or debit/check cards that are processed as credit cards are stored as a token by the payment gateway.

Set it to 1 (true) if you want to have the payment gateway store the card as a token.

The default for this field is 0 (false).

Allowable Values
  kill_dp_session string 3000

This field indicates whether Direct Post should kill the current session after it has submitted its transactions, either successfully or unsuccessfully.

If this field is set to 1 (true), Direct Post calls the kill_session_m API method, which disables the current session ID. 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 reattempt 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.

The default for this field is 0 (false). 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 for something other than Direct Post, and you want to utilize this field, you must call a separate instance of set_session_m or set_session_auth_m specifically for Direct Post.

Example: You set this field 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.

  alt_client_acct_group_id string 3000

This is a client group ID, which is your chosen unique ID code with which to identify a collection group. You add a client group ID when you create or edit a collection group.

Pass in a 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 group instead of the default Aria collection group or the collection group to which a customer is assigned.

Note: Passing in alt_client_acct_group_id does not assign a customer to the corresponding collection group. Unless you specify otherwise, future payments are processed using the default Aria collection group or the collection group to which a customer is assigned.

  do_ach_collect string 3000

Determines whether to perform a collection when ACH details are provided. Note that the min_collect_threshold will be honored for all collection attempts, so in cases where the amount to be collected falls below the min_collect_threshold, no collection will be performed.

Set this field to 0 (false) if you do not want to perform an ACH collection.

By default, do_ach_collect is set to 1 (true), which will perform an ACH collection.

Allowable Values
 

no_reuse_session_ind

string 3000

If this field is set to 1 (true), Direct Post calls the kill_session_m 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_m or set_session_auth_m again to start a new session if you want to reattempt 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.

This field is set to 0 (false) 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_m or set_session_auth_m API method for something other than Direct Post and you want to utilize the no_reuse_session_ind 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 no_reuse_session_ind field 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.

Allowable Values
 

alt_caller_id

string 3000

You can use this parameter to pass in your chosen value to associate with an API call used to create or modify your customer data. For example, you can pass in the user ID of the person making an API call. 

The value that you pass into the alt_caller_id parameter is displayed in your API call logs in Aria in a column named Caller ID

Note: To be able to pass a value into the alt_caller_id parameter, you must first contact Aria Customer Support to enable the parameter for your company.

 

track_data1

string 3000

If credit card numbers are added to your accounts via a swipe machine (card-present transactions), Direct Post accepts inputs consisting of the track 1 and track 2 data retrieved from the swiped credit cards. You can pass the track 1 and track 2 data into the track_data1 and track_data2 parameters in Direct Post.

 

track_data2

string 3000

If credit card numbers are added to your accounts via a swipe machine (card-present transactions), Direct Post accepts inputs consisting of the track 1 and track 2 data retrieved from the swiped credit cards. You can pass the track 1 and track 2 data into the track_data1 and track_data2 parameters in Direct Post.

 

track_data2

string 3000

If credit card numbers are added to your accounts via a swipe machine (card-present transactions), Direct Post accepts inputs consisting of the track 1 and track 2 data retrieved from the swiped credit cards. You can pass the track 1 and track 2 data into the track_data1 and track_data2 parameters in Direct Post.

Start of proc_field_override array
  brd_arrow.gif proc_field_override array  

Your chosen data to send to your payment gateway passed as an array of proc_field_name/proc_field_value key-value pairs.

The allowable field(s) and values for the key-value pairs are listed below.

  Field Name Field Type Max Length Description
    brd_arrow.gifbrd_arrow.gif transaction_type string 2

If you use Chase Paymentech, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's  payment information.

This field applies to credit cards and tokenized credit cards. If you don't pass a value into this field, it will default to -1 (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 allowable 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:

  1. value passed into this field
  2. collection group configuration
  3. payment gateway configuration
  4. transaction type that you specified in the <recurring_processing_model_ind> field
Allowable Values
End of proc_field_override array
End of in_reg_uss_config_params array
Start of fraud_control_fields array
Req Field Name Field Type Max Length Description
  fraud_control_fields array   Your chosen fraud protection options passed as an array of fraud_control_field_name/fraud_control_field_value key-value pairs. This array allows you to specify your fraud scoring and fraud filtering options. To use fraud protection, you must have fraud functionality enabled and configured in your payment gateway's portal. Contact your payment gateway representative for setup information and additional documentation. The allowable fields and values for the key-value pairs are highlighted in blue below.
  fraud_control_field_name Field Type Max Length fraud_control_field_value:
  • Field Type: string
  • Max Length: 100
 
fraud_filtering_enabled
string 100

Indicates whether to send a request to the processor for fraud filtering information. If you set it to 0 (false), then Aria will ignore all other fraud filtering fields.

The default value is 0 (false).

Allowable Values

 
change_mp_status_on_fraud_filtering_cc_prefix_failure
string 100

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 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. 

The default value is 0 (false).

Allowable Values

 
mp_status_on_fraud_filtering_cc_prefix_failure
string 100

If change_mp_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance.

The default value is null.

    change_mp_status_on_fraud_filtering_cc_number_failure string 100

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 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status.

The default value is 0 (false).

Allowable Values

    mp_status_on_fraud_filtering_cc_number_failure string 100

If change_mp_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance.

The default value is null.

 
change_mp_status_on_fraud_filtering_cc_issuing_country_failure
string 100

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 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status.

The default value is 0 (false).

Allowable Values

 
mp_status_on_fraud_filtering_cc_issuing_country_failure
string 100

If change_mp_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance.

The default value is null.

 
change_mp_status_on_fraud_filtering_cc_issuing_country_suspect
string 100

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 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status.

The default value is 0 (false).

Allowable Values

 
mp_status_on_fraud_filtering_cc_issuing_country_suspect
string 100

If change_mp_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the master plan instance.

The default value is null.

 
fraud_scoring_enabled
 
string 100

Indicates whether to send a request to the processor for a fraud score.  If you set it to 0 (disable), then Aria will ignore all other fraud scoring fields.

The default value is 0 (false).

Allowable Values

 
fraud_scoring_threshold
string 100

Allows you to set a threshold that your payment processor 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.

The default value is 0 (false).

To use fraud scoring, you must have it enabled and configured in your payment gateway's portal. Contact your payment gateway representative for setup information and additional documentation.

As of now, it is not supported for the Vantiv (Litle) processor.

  change_mp_status_on_fraud_scoring_failure   string 100

Indicates whether to change the status of the master plan instance(s) if the fraud scoring request returns a failure response. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status.

The default value is 0 (false).

 Allowable Values

 
mp_status_on_fraud_scoring_failure
string 100

If change_mp_status_on_fraud_scoring_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance.

The default value is null.

  change_mp_status_on_fraud_scoring_review string 100

This is a flag that indicates that the master plan instance status should be changed if a fraud scoring enabled was performed and "review" was returned as part of the fraud score result. Set it to 1 (true) if changing the master plan instance status is desired.

The default value is 0 (false).

Allowable Values

 
mp_status_on_fraud_scoring_review
string 100

If change_status_on_fraud_scoring_review is set to 1 (true), use this field to indicate the desired status of the master plan instance.

The default value is null.
End of fraud_control_fields array
Req Field Name Field Type Max Length Description
  perform_marketing_insights_inquiry long 2 Returns marketing information if your payment processor supports it and it is configured in Aria. Allowable Values
  perform_balance_inquiry long 1 If your payment processor supports it, this will provide a balance inquiry that reflects the current balance for prepaid cards and gift cards. Allowable Values
 

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
 
 
 
Last modified

Tags

Classifications

This page has no classifications.