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 on Account Creation Date

Register an Account using a Credit Card for a Paid Plan with Billing Date on Account Creation Date

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 the account creation date:

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

Note: Funds might not be available in the customer’s bank account when the collection transaction is settled.

Assumptions

The process described in the electronic check payment flow for paid plans 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.
  • Making the billing date the same as the account creation date.

Preconditions

Select Aria6 Options

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

Create your Direct-Post Configuration Set

To create a Direct-Post configuration set for account registration for paid plans using the credit card payment method when the billing date is the same as the account creation date, 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_ .Example: The configuration set for account registration used for paid plans when the billing date is the same as the account creation date could be named direct_post_paidreg.
  4. Set the fields in the in_reg_uss_config_params array to the values listed below:
  • redirecturl - Set this field to the URL in your User Self Service application on which you display error or success messages. These messages are sent by Direct-Post.
  • min_auth_threshold - Set this field to the minimum amount for which a credit card authorization should be completed. The default value is 1 ($1). Example: If an invoice total should be at least $10 before an electronic payment authorization occurs, set this field to 10.
  • do_cc_auth - Set this field to 1. This does the followiing:
    • Triggers the update_acct_complete call that will set the payment method for the account to credit card.
    • Triggers the authorize_electronic_payment call that will authorize the credit card for the invoice total passed by the get_invoice_details call.
  • change_status_on_cc_auth_failure - Set this field to 1. This indicates that the account status should be changed after a failed credit card authorization. Refer to the status_cd allowable values in the create_acct_complete documentation for the list of available account statuses.
  • change_status_on_c_auth_success - Set this field to 1. This indicates that the account status should be changed after a successful credit card authorization. Refer to the status_cd allowable values in the create_acct_complete documentation for the list of available account statuses.

Note: If the account status is active and the customer registered for paid services, then the credit card authorization fails, the account remains billable and invoices continue to be generated for the customer. Therefore, it is recommended that you use Direct-Post to specify the status to which the account should be set if the credit card authorization fails.
If you deactivate an account after a failed credit card authorization, then the credit card authorization succeeds after another attempt, set the account to your chosen status after the successful authorization attempt. Example: Set the account status to active to make the account billable.

  • no_invoice_promotion- Set this field to 0. This does the following:
    • Triggers the get_pending_invoice_no call to obtain the pending invoice number.
    • Triggers the get_invoice_details call obtains the details of the invoice.
    • Triggers the manage_pending_invoice call to approve the pending invoice. 

Postconditions

At the end of the account registration process described in the credit card payment flow for paid plans when the billing date is the same as the account creation date, 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 the same as the account creation date. 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 on Account Creation Date

Registering an Account using a Credit Card for a Paid Plan with Billing Date on Account Creation Date

Follow the steps listed below to register an account for paid plans using the credit card payment method when the billing date is the same as the account creation date:

  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 status_cd field to 1. This makes the account billable so an invoice can be generated for it.
  4. Set the do_full_invoicing field to false. This prevents the account from being invoiced at this point.
  5. Set the master_plan_no field to the number assigned to the master plan that the customer selected.
  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 5 below.

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

  1. Use the gen_invoice call to generate a pending invoice.

Precondition: An account exists. An account number was returned by the create_acct_complete call that you pass into the gen_invoice call.

  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 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.
  1. Use the set_session call to obtain an Aria session ID for Direct-Post.

Precondition: An account exists.

  • Set the client_no field to your Aria-assigned ID number.
  • Set the auth_key field to your Aria-assigned authorization key.
  • 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 bank account 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_ 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 Credit Card.
  5. Set the cc_num 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.

  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 the payment method has been set to credit card.

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