Home > Aria6 User Documentation > Best Practices > Account Registration > Registering an Account > Register an Account using a Credit Card for a Paid Plan with Billing Date in the Future and with a Prorated Invoice

Register an Account using a Credit Card for a Paid Plan with Billing Date in the Future and with a Prorated Invoice

This is the recommended process to follow to register an account for a customer who is signing up for one or more paid plans using the credit card payment method when the billing date is in the future and proration occurs:

  • Create the account.
  • Generate a pending invoice.
  • Authorize the credit card.
  • Approve the pending invoice.
  • Collect the payment.
  • Send the statement.

Assumptions

The process described in the credit card payment flow for paid plans with a future billing date and a prorated Invoice deals with:

  • Creating an independent account, not a parent-child account.
  • Assigning a master plan and optional supplemental plans to an account.
  • Creating an account with no orders or coupons.

Preconditions

  1. Create your Master Plan(s) with the Desired Account Status

Create your master plan(s) in Aria6 and specify the status that an account to which the plan is assigned should have.

  1. Select Aria6 Options
  • To automatically collect a payment from a customer after a pending invoice is approved, this option must be set to True in Aria6: Auto Collect On Pending Invoice Approval.
  • To automatically send a statement to a customer after a pending invoice is approved, this option must be set to True in Aria6: Auto Send Statement On Pending Invoice Approval.
  1. Create your Direct-Post Configuration Set

You can use the same configuration set that you created for account registration with the credit card payment method for paid plans when the billing date is the same as the account creation date. For more information, see:
Registering an Account using a Credit Card for a Paid Plan with Billing Date on Account Creation Date

Postconditions

At the end of the account registration process described in the credit card payment flow for paid plans when the billing date is in the future and proration occurs, the following results are achieved:

  • A new account exists that includes billing contact information and an authorized payment method.
  • If you enabled the option in the Aria6 application to automatically send a statement after a pending invoice is approved, the customer receives a statement.

Process Flow Diagram

The diagram below illustrates the recommended process for registering an account for paid plans when using the credit card payment method when the billing date is in the future and proration occurs:

The grey boxes indicate functions automatically triggered by Direct-Post based on your configuration set.

Credit Card Payment Process Flow for Paid Plans with Billing Date in the Future and with a Prorated Invoice

Registering an Account using an Electronic Check for a Paid Plan with Billing Date in the Future and with a Prorated Invoice

Follow the steps below to register an account for paid plans using the credit card payment method when the billing date is in the future and proration occurs:

  1. Use the create_acct_complete call to create an account.

Precondition: A customer visits your website and signs up for one or more paid service plans.

  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 do_prorated_invoicing field to false. You can use the gen_invoice call to generate a prorated invoice.

Example:  If the account creation date is 11/1/11, the do_prorated_invoicing field is set to false, and the alt_bill_day field in the gen_invoice call is set to 15, then the customer’s first invoice covers a period from 11/1/11 to 11/14/11. The customer’s second invoice covers a period from 11/15/11 to 12/14/11, etc.

  1. 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.
  2. Leave the alt_bill_day and alt_start_date fields blank. You must set the alternate billing date using the gen_invoice call as described in Step 2 below.
  3. Set the master_plan_no field to the number assigned to the master plan that the customer selected.
  4. Set the supp_plans field to the array of supplemental plan numbers assigned to any supplemental plans that the customer selected.
  5. Set the userid field to the user ID that the customer entered.
  6. Set the password field to the password that the customer entered.
  7. 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 5 below.

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

  1. Use the gen_invoice call to specify an alternate billing date and generate a prorated, pending invoice.

Preconditions:

  • An account was created.
  • An account number was returned by the create_acct_complete call that you pass into the gen_invoice call.
  • The account is in a billable status.
  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.
  4. Set the alt_bill_day field to the day of the month on which the customer should be billed. This specifies an alternate billing date for the account.

Examples:

If the account creation date is 11/1/11 and you want the customer to be billed on the 19th of every month, set this field to 19. Because a prorated invoice has been created, the customer is billed for a period from 11/1/11 to 11/18/11, then from 11/19/11 to 12/18/11, etc.

If the account creation date is 11/21/11 and you want the customer to be billed on the 20th of every month, set this field to 20. Because a prorated invoice has been created, the customer is billed for a period from 11/21/11 to 12/19/11, then from 12/20/11 to 1/19/12, etc.

Note: The length of the proration period cannot be longer than the shortest billing period for any of the customer’s plans.

Example: If the customer registered for one plan that is billed monthly and a different plan that is billed quarterly, the proration period cannot be longer than one month. Therefore, the billing date that you specify cannot be more than one month into the future.

  1. 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 for the prorated amount. When an invoice is pending, a collection is not attempted.
  • An invoice number is returned.
  1. Use the set_session call to obtain an Aria session ID for Direct-Post.

Precondition: An account exists.

  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.

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

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

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.

Example:  If you named your configuration set “direct_post_paidbillnowreg”, then you would set the mode field to “paidbillnowreg”. The mode field is a hidden field.

  1. Set the inSessionID field to the session ID returned by the set_session call. The inSessionID field is a hidden field.
  2. Set the client_no field to your Aria-assigned client number. The client_no field is a hidden field.
  3. Set the formOfPayment field to CreditCard.
  4. Set the cc_no field to the bank routing number that the customer entered.
  5. Set the cc_exp_mm field to the credit card expiration month that the customer entered.
  6. Set the cc_exp_yyyy field to the credit card expiration year that the customer entered.
  7. Set the cvv field to the Card Verification Value (CVV) that the customer entered.

Postcondition: The session ID is returned.

  1. Direct-Post triggers secure payment transactions and invoice and account changes 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 account to credit card.
  3. Authorizes the credit card for the invoice amount..
  4. Sets the account status to your chosen value based on the success or failure of the credit card authorization..
  5. Approves the pending invoice after a successful credit card authorization..

Note: If an error occurs after Steps b, c, d, or e above, then redisplay the payment information page and repeat the process beginning with Step 4.

Postconditions:

  • A session ID is returned.
  • The credit card is authorized.
  • An invoice number is returned.
  • The pending invoice is approved.
  1. The validate_session call obtains the account number.

Precondition: The pending invoice was approved.

  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 session_id field to the session ID returned by Direct-Post.

Postcondition: The customer’s user ID and account number are returned.

  1. The get_invoice_details call obtains the details of the invoice

Preconditions:

  • An account number was returned by the validate_session call.
  • An invoice number was returned by Direct-Post.

 

  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 validate_session call.
  4.     Set the src_transaction_id field to the invoice number returned by Direct-Post.

Postcondition: The invoice details are returned.

  1. 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 was approved by Direct-Post.

Postcondition: The payment is collected from the customer.

  1. 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 Aria6 is set to True.
  •  The pending invoice was approved by Direct-Post.

Postcondition: The statement is sent to the customer’s billing email address.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®