Home > Aria6 User Documentation > Best Practices > Account Registration > Registering Parent-Child Accounts > Simultaneously Registering a Parent and a Child Account with Responsibility Level 2, 3, or 4 Using a Credit Card for a Paid Plan

Simultaneously Registering a Parent and a Child Account with Responsibility Level 2, 3, or 4 Using a Credit Card for a Paid Plan

Overview

Follow this process to register an account for a customer who is signing up for a parent account and a child account with responsibility level 2 using a credit card for a paid plan at the same time that the parent account was created:

  1. Create a parent and one or more child accounts.
  2. Generate pending invoices for the parent and child accounts.
  3. Authorize the parent account holder’s credit card.
  4. Approve the pending invoices.
  5. Collect the payment from the parent account holder.
  6. Send the statement to the parent account holder.

Assumptions

The process described in the credit card payment flow for a registering a parent account and a child account with responsibility level 2 at the same time that the parent account was created:

  • Assigning a master plan to an account.
  • Creating an account with no orders.

Preconditions


Select Aria6 Options

  • To automatically collect a payment from a customer after a pending invoice is approved, set this option to True in Aria6:
    • Auto Collect On Pending Invoice Approval
  • To automatically send a statement to a customer after a pending invoice is approved, set this option to True in Aria6:
    • Auto Send Statement On Pending Invoice Approval

Create your Direct‐Post Configuration Set

To create a Direct‐Post configuration set for parent and child account registration for paid plans using a credit card, define the following name‐value pairs in the set_reg_uss_config_params API call:

  1. Set the client_no field to your Aria‐assigned client number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the set_name field to the name of your configuration set. The name of your configuration set must begin with direct_post_.
    For example, the configuration set could be named direct_post_paidreg.
  4. Set the redirecturl field in the in_reg_uss_config_params array to the URL in your account registration application where you display error or success messages. These messages are sent by Direct Post.

    Setting this field causes Direct Post to trigger the update_ acct_ complete call to set the payment method of the parent account to credit card.

Postconditions

At the end of the account registration process described in the credit card payment flow for creating a parent account and a child account with responsibility level 2 at the same time:

  • A parent account and one or more new child accounts exist.
  • If you enabled the option in Aria6 to automatically collect a payment from a customer after a pending invoice is approved, a payment is collected from the parent account holder.
  • If you enabled the option in Aria6 to automatically send a statement after a pending invoice is approved, the parent account holder receives a statement.

Process Flow Diagram

The diagram below illustrates the recommended process for registering a parent account and a child account with responsibility level 2 at the same time using a credit card for a paid plan:

parent-child-flow3a.png

 Notes:

  • Call the create_acct_complete, gen_invoice, get_invoice_details, and manage_pending_invoice methods again for each additional child account that the customer added.
  • The light grey boxes indicate functions automatically triggered by Direct‐Post based on your configuration set.
  • The dark grey boxes indicate functions automatically performed by Aria.
  • If the customer abandons the registration process before the pending invoice is approved and while the account status is billable, Aria will continue to generate invoices for the account. You may choose to deactivate the account to prevent additional invoices from being generated.

Instructions

Follow the steps below to register an account for a customer who is signing up for a parent account and a child account with responsibility level 2 at the same time for a paid plan:

Step 1: Use the create_acct_complete call to create the parent account.

Precondition: A customer visits your website and signs up for a parent account and one or more child accounts in the same sitting.

  1. Set the client_no field to your Aria‐assigned ID number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the do_full_invoicing field to false. This prevents the account from being invoiced at this point.
  4. If the status in the master plan is not billable, set the status_cd field to a billable status. Refer to the status_cd legend in the create_acct_complete API documentation for the list of account statuses.
  5. Set the master_plan_no field to the number assigned to the master plan that the customer selected for the parent account.
  6. Set the supp_plans field to the array of supplemental plan numbers assigned to any supplemental plans that the customer selected.
  7. Set the userid field to the user ID that the customer entered.
  8. Set the password field to the password that the customer entered.
  9. Set additional fields based on your company’s requirements.

Note: It is not recommended that you set the credit card fields using the create_acct_complete call. It is recommended that you use Direct Post to set the credit card fields as described in Step 10.

Postcondition: The account is created and an account number is returned.

 

Step 2: Use the create_acct_complete call to create a child account.

Precondition: A customer visits your website and signs up for a parent account and one or more child accounts in the same sitting.

  1. Set the client_no field to your Aria‐assigned ID number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the do_full_invoicing field to false. This prevents the account from being invoiced at this point.
  4. Set the resp_level_cd field to 2, 3, or 4.
  5. Set the senior_acct_no field to the account number of the parent account.
  6. Set the master_plan_no field to the number of the master plan that the customer selected for the child account.
  7. If the status in the master plan is not billable, set the status_cd field to a billable status. Refer to the status_cd allowable values in the create_acct_complete API documentation for the list of account statuses.
  8. Set the master_plan_no field to the number assigned to the master plan that the customer selected.
  9. Set the userid field to the user ID that the customer entered.
  10. Set the password field to the password that the customer entered.
  11. Set additional fields based on your company’s requirements.

Postcondition: The account is created and an account number is returned.

Step 3: Use the gen_invoice call to generate a pending invoice for the parent account.

Precondition: An account was created. An account number was returned by the create_acct_complete call used to create the parent account.

  1. Set the client_no field to your Aria‐assigned ID number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the acct_no field to the account number returned by the create_acct_complete call used to create the parent account.
  4. Set the force_pending field to true.

Note: If the pending invoices option is set to false in your Aria implementation, the API call overrides the setting in your Aria implementation.

Postconditions:

  • A pending invoice is generated. When an invoice is pending, a collection is not attempted.
  • An invoice number is returned.


Step 4: The get_invoice_details call obtains the details of the invoice generated for the parent account.

Precondition: An invoice number was returned by the gen_invoice call used to generate an invoice for the parent account.

  1. Set the client_no field to your Aria‐assigned ID number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the acct_no field to the account number returned by the create_acct_complete call used to create the parent account.
  4. Set the src_transaction_id field to the invoice number returned by the gen_invoice call used to generate an invoice for the parent account.

Postcondition: The invoice details are returned.


Step 5: Use the gen_invoice call to generate a pending invoice for the child account.

Precondition: An account was created. An account number was returned by the create_acct_complete call used to create the child account.

  1. Set the client_no field to your Aria‐assigned ID number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the acct_no field to the account number returned by the create_acct_complete call used to create the child account.
  4. Set the force_pending field to true.

Note: If the pending invoices option is set to false in your Aria implementation, the API call overrides the setting in your Aria implementation.

Postconditions:

  • A pending invoice is generated. When an invoice is pending, a collection is not attempted.
  • An invoice number is returned.

 

Step 6: The get_invoice_details call obtains the details of the invoice generated for the child account.

Precondition: An invoice number was returned by the gen_invoice call used to generate an invoice for the child account.

  1. Set the client_no field to your Aria‐assigned ID number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the acct_no field to the account number returned by the create_acct_complete call used to create the child account.
  4. Set the src_transaction_id field to the invoice number returned by the gen_invoice call used to generate an invoice for the child account.

Postcondition: The invoice details are returned.


Step 7: Use the gen_invoice and get_invoice_details calls in sequence again for each additional child account for which the customer registered.

Step 8: Obtain the total combined balance of the parent account and child account(s).

Step 9: Use the set_session API call to obtain an Aria session ID for Direct Post.

Precondition: A parent account and one or more child accounts were created.

  1. Set the client_no field to your Aria‐assigned ID number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the user_id field to the user ID that the customer entered for the parent account.

Postcondition: An Aria session ID for Direct‐Post is obtained.

Step 10: Transmit credit card information from your payment information page to Direct Post.

Preconditions:

  • You created a Direct‐Post configuration set.
  • An Aria session ID for Direct‐Post was obtained.
  • The customer entered credit card information for the parent account.

Transmit the following fields and values from your payment information page to Direct Post:

  1. Set the mode field to the suffix of the configuration set that you created.
    For example, if you named your configuration set "direct_post_paidreg", then you would set the mode field to “paidreg”. The mode field is a hidden field.
  2. Set the inSessionID field to the session ID returned by the set_session call. The inSessionID field is a hidden field.
  3. Set the client_no field to your Aria‐assigned client number. The client_no field is a hidden field.
  4. Set the formOfPayment field to CreditCard.
  5. Set the cc_no field to the credit card number that the customer entered.
  6. Set the cc_exp_mm field to the credit card expiration month that the customer entered.
  7. Set the cc_exp_yyyy field to the credit card expiration year that the customer entered.
  8. Set the cvv field to the Card Verification Value (CVV) that the customer entered.

Postcondition: The session ID is returned.

Step 11: Direct‐Post triggers secure credit card transactions based on your configuration set.

Precondition: Credit card information was transmitted from your payment information page to Direct‐Post.

Direct Post does the following:

  1. Verifies the validity of the session.
  2. Sets the payment method of the parent account to credit card.

Note: If an error occurs after Step b above, then redisplay the payment information page and repeat the process beginning with Step 10.

Postconditions:

  • A session ID is returned.
  • The payment method of the parent account is set to credit card.


Step 12: The authorize_electronic_payment call authorizes the parent account’s credit card for the total combined balance of the parent account and child account(s).

Preconditions:

  • An account number was returned by the create_acct_complete call used to create the parent account.
  • You obtained the total combined balance of the parent and child invoices.
  1. Set the client_no field to your Aria‐assigned ID number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the acct_no field to the account number returned by the create_acct_complete call used to create the parent account.
  4. Set the amount field to the amount of the total combined balance of the parent account and child account(s).

Note: If the customer abandons the registration process before the pending invoice is approved and while the account status is billable, Aria continues to generate invoices for the account. You may choose to deactivate the account to prevent additional invoices from being generated.

Postcondition: The credit card is authorized.

 

Step 13: Use the manage_pending_invoice call to approve the pending invoice generated for the child account.

Preconditions:

  • The customer confirmed the account, plan, and invoice information.
  • The gen_invoice call generated a pending invoice for the child account.
  1. Set the client_no field to your Aria‐assigned ID number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the invoice_no field to the invoice number returned by the gen_invoice call used to generate an invoice for the child account.
  4. Set the action_directive field to 1 to approve the pending invoice.

Postconditions:

  • The pending invoice for the child account is approved.
  • The balance of the child invoice is transferred to the parent account.


Step 14: Use the manage_pending_invoice call again for any additional pending invoices generated for child accounts.


Step 15: Use the manage_pending_invoice call to approve the pending invoice generated for the parent account.

Precondition: The gen_invoice API call generated a pending invoice for the parent account.

  1. Set the client_no field to your Aria‐assigned ID number.
  2. Set the auth_key field to your Aria‐assigned authorization key.
  3. Set the invoice_no field to the invoice number returned by the gen_invoice call used to generate an invoice for the parent account.
  4. Set the action_directive field to 1 to approve the pending invoice.

Postcondition: The pending invoice for the parent account is approved.


Step 16: The Auto Collect On Pending Invoice Approval option in Aria6 collects the payment from the customer.

Preconditions:

  • The Auto Collect On Pending Invoice Approval option in Aria6 is set to True.
  • The pending invoice for the parent account was approved.

Postcondition: The payment is collected from the parent account holder.

Step 17: The Auto Send Statement On Pending Invoice Approval option in Aria6 sends the statement to the customer.

Preconditions:

  • The Auto Send Statement On Pending Invoice Approval option in Aria6is set to True.
  • The pending invoice for the parent account was approved.

Postcondition: The statement is sent to the parent account holder’s billing email address.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®