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



 

Home > Aria Crescendo Documentation > Basic Registration Use Case

Basic Registration Use Case

This article applies to:Aria Crescendo

Overview

In this basic use case, you have a customer who wants to sign up for 1 master plan (product) and pay for it using 1 payment method. To sign up this customer, you would create an account with 1 master plan and 1 billing group as shown in the sample call below.

For samples that apply to more complex use cases, see Additional Registration Use Cases.

Note: The sample call shown below contains the minimum required fields and other key fields needed to successfully create an account. You may choose to pass in additional values to customize or screen an account based on your business requirements. Examples: you may want to assign a customer to a functional account group to identify the geographic region that the customer belongs to or to screen the customer by using fraud protection.

Please see the create_acct_complete_m API documentation for detailed information about additional available fields.

Sample Call

  1. Pass in your client number and authorization key:

<lit:client_no>12345_sample_client_no</lit:client_no>
<lit:auth_key>AbCdEfG_sample_auth_key</lit:auth_key>
  1. Pass values into these fields to specify login (for your user self service application) and contact information for the account:
<lit:acct>           
            <lit:acct_row>             
               <lit:acct/>             
               <lit:client_acct_id></lit:client_acct_id>             
               <lit:userid>jsmith</lit:userid>             
               <lit:status_cd>1</lit:status_cd>             
               <lit:notify_method></lit:notify_method>             
               <lit:password>password123</lit:password>             
               <lit:secret_question></lit:secret_question>             
               <lit:secret_question_answer></lit:secret_question_answer>             
               <lit:acct_contact_idx></lit:acct_contact_idx>             
               <lit:first_name>John</lit:first_name>             
               <lit:mi></lit:mi>             
               <lit:last_name>Smith</lit:last_name>             
               <lit:company_name></lit:company_name>             
               <lit:address1>123 Main Street</lit:address1>             
               <lit:address2></lit:address2>             
               <lit:address3></lit:address3>             
               <lit:city>Any Town</lit:city>             
               <lit:locality></lit:locality>             
               <lit:state_prov>PA</lit:state_prov>             
               <lit:country>US</lit:country>             
               <lit:postal_cd>19008</lit:postal_cd>             
               <lit:phone></lit:phone>             
               <lit:phone_ext></lit:phone_ext>             
               <lit:cell_phone></lit:cell_phone>             
               <lit:work_phone></lit:work_phone>             
               <lit:work_phone_ext></lit:work_phone_ext>             
               <lit:fax></lit:fax>             
               <lit:email>sample@ariasystems.com</lit:email>             
           </lit:acct_row>
</lit:acct>
  1. Pass values into these fields to add the account to a collection group and specify the currency in which the account will be billed as shown below.

    Adding the account to a collection group will ensure that the account's payments will be processed by the payment gateway associated with that collection group.
               <lit:collection_acct_group>
                  <lit:collection_acct_group_row>                    
                     <lit:collections_acct_group_no>2853</lit:collections_acct_group_no>                   
                     <lit:client_collections_acct_group_id></lit:client_collections_acct_group_id>
                  </lit:collection_acct_group_row>
               </lit:collection_acct_group>
            <lit:acct_currency>USD</lit:acct_currency>
  1. Pass values into these fields to assign a payment method to the account:
          <lit:payment_method>
                  <lit:payment_method_row>                     
                     <lit:pay_method_type>1</lit:pay_method_type>                     
                     <lit:pay_method_name>PM01</lit:pay_method_name>                     
                     <lit:pay_method_description></lit:pay_method_description>                     
                     <lit:client_pay_method_cdid></lit:client_pay_method_cdid>                     
                     <lit:payment_method_idx>1</lit:payment_method_idx>                     
                     <lit:bill_contact_idx></lit:bill_contact_idx>                     
                     <lit:first_name>John</lit:first_name>                     
                     <lit:mi></lit:mi>                     
                     <lit:last_name>Smith</lit:last_name>                     
                     <lit:company_name></lit:company_name>                     
                     <lit:address1>234 Maple Street</lit:address1>                     
                     <lit:address2></lit:address2>                     
                     <lit:address3></lit:address3>                     
                     <lit:city>Broomall</lit:city>                     
                     <lit:locality></lit:locality>                     
                     <lit:state_prov>PA</lit:state_prov>                     
                     <lit:country>US</lit:country>                     
                     <lit:postal_cd>19019</lit:postal_cd>                     
                     <lit:phone></lit:phone>                     
                     <lit:phone_ext></lit:phone_ext>                     
                     <lit:cell_phone></lit:cell_phone>                     
                     <lit:work_phone></lit:work_phone>                     
                     <lit:work_phone_ext></lit:work_phone_ext>                     
                     <lit:fax></lit:fax>                     
                     <lit:email>sample@ariasystems.com</lit:email>                     
                     <lit:birthdate></lit:birthdate>                     
                     <lit:cc_num>4111111111111111</lit:cc_num>                     
                     <lit:cc_expire_mm>12</lit:cc_expire_mm>                     
                     <lit:cc_expire_yyyy>2024</lit:cc_expire_yyyy>
                 </lit:payment_method_row>
             </lit:payment_method>
  1. Pass values into these fields to assign a billing group to the master plan as shown below.

    This will ensure that payments for the plan will be made using the payment method associated with that billing group.


<lit:billing_group>                
                  <lit:billing_group_row>                     
                     <lit:billing_group_name>BG01</lit:billing_group_name>                     
                     <lit:billing_group_description></lit:billing_group_description>                     
                     <lit:client_billing_group_id></lit:client_billing_group_id>                     
                     <lit:billing_group_idx>1</lit:billing_group_idx>                     
                     <lit:notify_method>1</lit:notify_method>                     
                     <lit:notify_template_group></lit:notify_template_group>                     
                     <lit:statement_template>112</lit:statement_template>                     
                     <lit:credit_note_template></lit:credit_note_template>                     
                     <lit:payment_option></lit:payment_option>                     
                     <lit:primary_client_payment_method_id></lit:primary_client_payment_method_id>                     
                     <lit:primary_payment_method_idx>1</lit:primary_payment_method_idx>                     
                     <lit:backup_client_payment_method_id></lit:backup_client_payment_method_id>                     
                     <lit:backup_payment_method_idx></lit:backup_payment_method_idx>                    
                     <lit:stmt_contact_idx></lit:stmt_contact_idx>                     
                     <lit:first_name>John</lit:first_name>                     
                     <lit:mi></lit:mi>                     
                     <lit:last_name>Smith</lit:last_name>                     
                     <lit:company_name></lit:company_name>                     
                     <lit:address1>234 Maple Street</lit:address1>                     
                     <lit:address2></lit:address2>                     
                     <lit:address3></lit:address3>                     
                     <lit:city>Broomall</lit:city>                     
                     <lit:locality></lit:locality>                     
                     <lit:state_prov>PA</lit:state_prov>                     
                     <lit:country>US</lit:country>                     
                     <lit:postal_cd>19019</lit:postal_cd>                     
                     <lit:phone></lit:phone>                     
                     <lit:phone_ext></lit:phone_ext>                     
                     <lit:cell_phone></lit:cell_phone>                     
                     <lit:work_phone></lit:work_phone>                     
                     <lit:work_phone_ext></lit:work_phone_ext>                     
                     <lit:fax></lit:fax>                     
                     <lit:email>sample@ariasystems.com</lit:email>               
                 </lit:billing_group_row>
</lit:billing_group>
  1. Pass values into these fields to assign the account to a dunning group as shown below.

    This will ensure that if the customer's payments are past due, actions will be taken on the account as stated in the assigned dunning group.

               <lit:dunning_group>                
                  <lit:dunning_group_row>                     
                     <lit:dunning_group_name>DG01</lit:dunning_group_name>                     
                     <lit:dunning_group_description>DG01</lit:dunning_group_description>                     
                     <lit:client_dunning_group_id>1698576</lit:client_dunning_group_id>                     
                     <lit:dunning_group_idx>1</lit:dunning_group_idx>                     
                     <lit:dunning_process_no>1723</lit:dunning_process_no>                     
                     <lit:client_dunning_process_id>2470936</lit:client_dunning_process_id>
                  </lit:dunning_group_row>
               </lit:dunning_group>
  1. Pass values into these fields to assign a master plan to the account:
    <lit:master_plans_detail>               
                  <lit:master_plans_detail_row>                     
                     <lit:plan_no>136511</lit:plan_no>                     
                     <lit:client_plan_id></lit:client_plan_id>                     
                     <lit:plan_instance_description>BronzePlan</lit:plan_instance_description>                     
                     <lit:client_plan_instance_id></lit:client_plan_instance_id>                     
                     <lit:plan_instance_idx></lit:plan_instance_idx>                     
                     <lit:promo_cd></lit:promo_cd>                     
                     <lit:plan_instance_units>1</lit:plan_instance_units>
                     <lit:billing_group_idx>1</lit:billing_group_idx>
                     <lit:dunning_group_idx>1</lit:dunning_group_idx>
                 </lit:master_plans_detail_row>
   </lit:master_plans_detail>

        

Sample Response

You can use the <acct_no> returned by the API to search for the customer in the Aria application and confirm that the account was created correctly as described in the use case above.

      <ns1:create_acct_complete_mResponseElement>
         <ns1:error_code>0</ns1:error_code>
         <ns1:error_msg>OK</ns1:error_msg>
         <ns1:out_acct>
            <ns1:acct_no>3078787</ns1:acct_no>
            <ns1:userid>jsmith</ns1:userid>
            <ns1:client_acct_id xsi:nil="true"/>
            <ns1:acct_locale_no>10001</ns1:acct_locale_no>
            <ns1:acct_locale_name>System_US_English_locale</ns1:acct_locale_name>
            <ns1:acct_contact_no>6584910</ns1:acct_contact_no>
            <ns1:billing_contact_details>
               <ns1:payment_method_no>1</ns1:payment_method_no>
               <ns1:bill_contact_no>6584911</ns1:bill_contact_no>
            </ns1:billing_contact_details>
            <ns1:statement_contact_details>
               <ns1:billing_group_no>1545682</ns1:billing_group_no>
               <ns1:stmt_contact_no>6584912</ns1:stmt_contact_no>
            </ns1:statement_contact_details>
            <ns1:other_contact_details xsi:nil="true"/>
            <ns1:contract_details xsi:nil="true"/>
            <ns1:session_id xsi:nil="true"/>
            <ns1:billing_errors>
               <ns1:invoicing_error_code>0</ns1:invoicing_error_code>
               <ns1:invoicing_error_msg>OK</ns1:invoicing_error_msg>
               <ns1:collection_error_code>0</ns1:collection_error_code>
               <ns1:collection_error_msg>OK</ns1:collection_error_msg>
               <ns1:statement_error_code>0</ns1:statement_error_code>
               <ns1:statement_error_msg>OK</ns1:statement_error_msg>
               <ns1:billing_group_no>1545682</ns1:billing_group_no>
               <ns1:client_billing_group_id>1545682</ns1:client_billing_group_id>
            </ns1:billing_errors>
            <ns1:master_plans_assigned>
               <ns1:plan_instance_no>4072175</ns1:plan_instance_no>
               <ns1:client_plan_instance_id>4072175</ns1:client_plan_instance_id>
               <ns1:nso_order_no xsi:nil="true"/>
               <ns1:nso_order_status_label xsi:nil="true"/>
               <ns1:plan_unit_instance_details xsi:nil="true"/>
               <ns1:supp_plans_assigned xsi:nil="true"/>
               <ns1:out_contract xsi:nil="true"/>
               <ns1:third_party_errors xsi:nil="true"/>
            </ns1:master_plans_assigned>
            <ns1:invoice_info>
               <ns1:invoice_no>26112325</ns1:invoice_no>
               <ns1:billing_group_no>1545682</ns1:billing_group_no>
               <ns1:client_plan_instance_id xsi:nil="true"/>
               <ns1:proc_cvv_response xsi:nil="true"/>
               <ns1:proc_avs_response xsi:nil="true"/>
               <ns1:proc_cavv_response xsi:nil="true"/>
               <ns1:proc_status_code>
               <ns1:proc_status_text xsi:nil="true"/>
               <ns1:proc_payment_id xsi:nil="true"/>
               <ns1:proc_auth_code xsi:nil="true"/>
               <ns1:proc_merch_comments xsi:nil="true"/>
               <ns1:proc_initial_auth_txn_id xsi:nil="true"/>
               <ns1:invoice_charges_before_tax>30</ns1:invoice_charges_before_tax>
               <ns1:invoice_tax_charges>0</ns1:invoice_tax_charges>
               <ns1:invoice_charges_after_tax>30</ns1:invoice_charges_after_tax>
               <ns1:invoice_credit_amount>0</ns1:invoice_credit_amount>
               <ns1:invoice_total_amount>30</ns1:invoice_total_amount>
               <ns1:total_credit>0</ns1:total_credit>
               <ns1:total_tax_credit>0</ns1:total_tax_credit>
               <ns1:total_credit_before_tax>0</ns1:total_credit_before_tax>
               <ns1:total>30</ns1:total>
               <ns1:proration_result_amount>30</ns1:proration_result_amount>
               <ns1:expected_monthly_rec_cost>30</ns1:expected_monthly_rec_cost>
               <ns1:expected_annual_rec_cost>360</ns1:expected_annual_rec_cost>
               <ns1:invoice_items>
                  <ns1:invoice_line_no>1</ns1:invoice_line_no>
                  <ns1:plan_no>136511</ns1:plan_no>
                  <ns1:client_plan_id>Monthly_Plan</ns1:client_plan_id>
                  <ns1:plan_instance_no>4072175</ns1:plan_instance_no>
                  <ns1:client_plan_instance_id>4072175</ns1:client_plan_instance_id>
                  <ns1:plan_name>BronzePlan</ns1:plan_name>
                  <ns1:service_no>102</ns1:service_no>
                  <ns1:client_service_id>102</ns1:client_service_id>
                  <ns1:service_name>Recurring Fee</ns1:service_name>
                  <ns1:service_coa_id>1002</ns1:service_coa_id>
                  <ns1:client_service_coa_code xsi:nil="true"/>
                  <ns1:units>1</ns1:units>
                  <ns1:rate_per_unit>30</ns1:rate_per_unit>
                  <ns1:line_amount>30</ns1:line_amount>
                  <ns1:line_description>Recurring Fee</ns1:line_description>
                  <ns1:start_date_range>2018-11-09</ns1:start_date_range>
                  <ns1:end_date_range>2018-12-08</ns1:end_date_range>
                  <ns1:line_type>1</ns1:line_type>
                  <ns1:base_plan_units>1</ns1:base_plan_units>
                  <ns1:proration_factor>1</ns1:proration_factor>
                  <ns1:proration_text xsi:nil="true"/>
                  <ns1:proration_remaining_days xsi:nil="true"/>
                  <ns1:proration_description xsi:nil="true"/>
                  <ns1:credit_coupon_code xsi:nil="true"/>
                  <ns1:client_sku xsi:nil="true"/>
                  <ns1:order_no xsi:nil="true"/>
                  <ns1:item_no xsi:nil="true"/>
                  <ns1:client_item_id xsi:nil="true"/>
                  <ns1:adv_billing_period_total_days xsi:nil="true"/>
                  <ns1:rate_schedule_no>796270</ns1:rate_schedule_no>
                  <ns1:rate_schedule_tier_no>1</ns1:rate_schedule_tier_no>
                  <ns1:bill_from_address_no xsi:nil="true"/>
                  <ns1:ship_from_address_no xsi:nil="true"/>
                  <ns1:bill_to_address_no xsi:nil="true"/>
                  <ns1:ship_to_address_no xsi:nil="true"/>
               </ns1:invoice_items>
               <ns1:tax_details xsi:nil="true"/>
               <ns1:proc_fraud_filtering_info xsi:nil="true"/>
            </ns1:invoice_info>
         </ns1:out_acct>
      </ns1:create_acct_complete_mResponseElement>

Additional Registration Use Cases

Click on any of the links below to see instructions for implementing more complex registration uses cases involving a variety of scenarios such as different plan selections or billing options:

  1. Create an Account with 2 Master Plans Billed Separately
  2. Create an Account with a Retroactive Start Date and an Alternate Bill Day
  3. Create an Account with a Future Plan Activation Date

 

 


Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.