Create an Account with a Contract and a Destination Contact

Last updated
Save as PDF

Overview

In this use case, we will create an account with an annual contract for a monthly subscription. In addition, we will assign a custom rate to the subscription. We will also confirm that the customer's credit card can cover all of the invoice charges before collecting the payment.

Example: A customer signs up for an online streaming service plan at a promotional introductory rate for 1 year. Optionally, the customer may choose to order a non-subscription offering (or inventory item) such as a DVR (digital video recorder).

Based on your business model, you may need to calculate taxes on a service and/or inventory item based on an origin address (or shipping address). Depending on your business needs, you can specify the origin address by using a destination contact or service location.

Example: You sell the same product/service from multiple origin addresses and you want to calculate the taxes based on the origin address specific to each customer.

In the example shown below, we will have the taxes for a service calculated based on a destination contact.

Notes:

The type of tax calculation described above is available to you if you use one of the tax engines identified in the destination contact and service location documentation.
Please check your tax engine documentation for any additional configuration required to support tax calculation based on the destination contact or service location.

This use case involves 3 key steps:

Create the Account
Authorize the Payment
Collect the Payment

Instructions

A. Create the Account

Sample Call

Call the create_acct_complete_m API using the fields in the basic registration use case and pass values into the additional fields described below:

Create a pending invoice so that you can complete an authorization before collecting the payment, as described below:
Create a 1-year (12-month) contract for the customer's plan, as described below:
Specify the plan to which the contract applies, as described below:
Identify the service whose taxes will be calculated based on your specified address, as described below:
Optionally, if the customer is also ordering a non-subscription offering, you can add the order and its destination contact identifier as described below.
Note: If you are adding an order in the create_acct_complete_m call, the requested inventory item must be associated with the plan the customer is subscribing to. If the item is not associated with the plan, you can complete the order using the create_order_m API.
Assign promotional rates to the plan, as described below:
Pass in the details of the destination contact that should be used for calculating the taxes on the service that you identified in step 4:

Sample Response

B. Authorize the Payment

Sample Call

Call the authorize_electronic_payment_m API to confirm that the customer's credit card can cover all of the invoice charges, as described below:

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>

Pass values into the additional fields described below:
1. Identify the customer whose authorization you are completing, as described below:
2. Identify the amount of the authorization. Obtain the amount from the <invoice_total_amount> field returned by the create_acct_complete_m API call that you made in part A above:
3. Identify the credit card details and billing address for the authorization. This billing information should be the same as what you associated with the payment method in the create_acct_complete_m API call that you made in part A above.
4. Identify the plan for whose payment method you are completing an authorization. Obtain the plan instance's identifier from the <plan_instance_no> field returned by the create_acct_complete_m API call that you made in part A above.

If the authorization is successful, you can then approve the corresponding invoice and collect the payment as described in part C below. If the authorization is not successful, you may need to ask the customer to re-enter payment information in your registration application.

Sample Response

<ns1:authorize_electronic_payment_mResponseElement>
         <ns1:error_code>0</ns1:error_code>
         <ns1:error_msg>OK</ns1:error_msg>
         <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>100</ns1:proc_status_code>
         <ns1:proc_status_text>pass</ns1:proc_status_text>
         <ns1:proc_payment_id>1569437371.20014</ns1:proc_payment_id>
         <ns1:proc_auth_code>1569437371</ns1:proc_auth_code>
         <ns1:proc_merch_comments>Oy, I'm a test!</ns1:proc_merch_comments>
         <ns1:proc_fraud_filtering_info xsi:nil="true"/>
         <ns1:proc_payer_auth_request xsi:nil="true"/>
         <ns1:proc_redirect_issuer_url xsi:nil="true"/>
         <ns1:proc_md xsi:nil="true"/>
         <ns1:proc_card_available_balance xsi:nil="true"/>
         <ns1:proc_prepaid_ind xsi:nil="true"/>
         <ns1:proc_prepaid_reloadable xsi:nil="true"/>
         <ns1:proc_prepaid_card_type xsi:nil="true"/>
         <ns1:proc_affluence_type xsi:nil="true"/>
         <ns1:proc_issuing_country xsi:nil="true"/>
         <ns1:proc_card_product_type xsi:nil="true"/>
         <ns1:proc_signature_debit_ind xsi:nil="true"/>
         <ns1:proc_pinless_debit_ind xsi:nil="true"/>
         <ns1:proc_durbin_regulated_ind xsi:nil="true"/>
         <ns1:proc_initial_auth_txn_id xsi:nil="true"/>
</ns1:authorize_electronic_payment_mResponseElement>

C. Collect the Payment

Sample Call

Call the manage_pending_invoice_m API as described below to approve the pending invoice and collect a payment:

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>

Identify the customer from whom you are collecting a payment, as described below:
Identify the invoice that you are approving and for which you are collecting a payment. Obtain the invoice from the <invoice_no> field returned by the create_acct_complete_m API call that you made in part A above.
Specify that you will collect a payment after the invoice is approved, as described below:

Sample Response

 <ns1:manage_pending_invoice_mResponseElement>
         <ns1:new_invoice_no>40565871</ns1:new_invoice_no>
         <ns1:acct_no>3926802</ns1:acct_no>
         <ns1:client_acct_id xsi:nil="true"/>
         <ns1:billing_group_no>1714261</ns1:billing_group_no>
         <ns1:client_billing_group_id>1714261</ns1:client_billing_group_id>
         <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:proc_cvv_response xsi:nil="true"/>
         <ns1:proc_avs_response xsi:nil="true"/>
         <ns1:proc_cavv_response xsi:nil="true"/>
         <ns1:proc_status_code>100</ns1:proc_status_code>
         <ns1:proc_status_text>pass</ns1:proc_status_text>
         <ns1:proc_payment_id>1569438274.13344</ns1:proc_payment_id>
         <ns1:proc_auth_code>1569438274</ns1:proc_auth_code>
         <ns1:proc_merch_comments>Oy, I'm a test!</ns1:proc_merch_comments>
         <ns1:proc_initial_auth_txn_id xsi:nil="true"/>
         <ns1:error_code>0</ns1:error_code>
         <ns1:error_msg>OK</ns1:error_msg>
         <ns1:collection_errors xsi:nil="true"/>
 </ns1:manage_pending_invoice_mResponseElement>

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

You will see the destination contact that you created for the service on the customer's Account Contacts screen.