Section 2.2 Configuration Parameters

The main script configuration file is "process.cfm". Please open this file for review when reading the configuration section.

Account Information
Field Name Description
api_login Authorize.Net API Login ID
trans_key Authorize.Net Transaction Key

Configuration Information
Field Name Description
transaction_type

Accepts values of "create", "update", or "cancel".

- Set this value to "create" to create a new ARB Subscription Request.

- Set this value to "update" to update an existing ARB Subscription Request.

- Set this value to "cancel" to cancel an existing ARB Subscription Request.

create = ARBCreateSubscriptionRequest
update= ARBUpdateSubscriptionRequest
cancel = ARBCancelSubscriptionRequest


Example: transaction_type="create"

NOTE: The subscription_id parameter is required for update and cancel subscription requests

IMPORTANT NOTE FOR UPDATE SUBSCRIPTION REQUESTS:

+ start_date may only be updated in the event that no successful payments have been completed.

+ The subscription interval information length and unit may not be updated.

+ trial_occurrences may only be updated if the subscription has not yet begun or is still in the trial period.

test Accepts values of "true" or "false"

- Set this value to "true" to submit a test transaction using your Authorize.Net developer test account.

- Set this value to "false" to submit a live transaction using your live Authorize.Net account.

Note: Your Authorize.Net account must also be out of test mode to submit live transactions.

Subscription Information
Field Name Description
subscription_name

Name of the submitted Authorize.Net Subscription

Example: subscription_name="NPR Monthly Donation"
subscription_id Authorize.Net assigned identification number for the subscription. Required for "update" and "cancel" subscription requests.
reference_id Assigned by the merchant for tracking purposes only. This value does not appear in the Authorize.Net virtual terminal.
unit

Unit of time, in association with the length parameter. Accepts the values of "days" or "months".

Example: unit="months"

Note: If you create a new subscription with the first payment scheduled for that same day, the initial payment for the subscription will actually be submitted the next business day.
length If unit is "months," set this value to any number between one (1) and 12.

If unit is "days," set this value to any number between seven (7) and 365.

Example: length="3"
start_date

The date the subscription begins. Format: YYYY-MM-DD
total_occurrences

Indicates how many times to run the recurring subscription profile.

9999 = Indefinitely

To submit a subscription with no end date (an ongoing subscription), this field must be submitted with a value of “9999.” If a trial period is specified, this number should include the total number of trial occurrences (trial_occurrences).


Example: total_occurrences="9999"

trial_occurrences If a trial period is specified, this number must be included in the Total Occurrences (total_occurrences).
trial_amount The amount to be charged for each payment during a trial period.

Required when trial_occurrences is specified. Once the number of trial occurrences for the subscription is complete, the regular amount (amount) will be charged for each remaining payment.

Billing Information
Field Name Description
billing_company

cardholder’s company.

billing_firstname cardholder’s first name.
billing_lastname cardholder’s last name.
billing_address 3 The cardholder’s billing street address (number and street name).
billing_city 3 cardholder’s billing city.
billing_state 3 cardholder’s billing state.
billing_zip 3 cardholder’s billing zip.
billing_country 3 cardholder’s billing country.
phone 3 cardholder’s phone.
fax cardholder's fax.
email 3 cardholder’s email address.

Shipping Information
Field Name Description
shipping_firstname Shipping First Name
shipping_lastname Shipping Last Name
shipping_address Shipping Address
shipping_city Shipping City
shipping_state Shipping State
shipping_zip Shipping Zip
shipping_country Shipping Country

Transaction Information
Field Name Description
card_num The credit card or purchase card number may not
contain spaces, non-numeric characters, or dashes.
For example, "4111111111111111"
exp_date Expiration date of the credit card in YYYY-MM format.
For example, 2010-08 represents August 2010.
amount Amount (US Dollars) U.S. based currency.
Specify the exact amount to the cent using a decimal
point—use 34.00, not 34. Do not include comma
separators—use 1199.95 not 1,199.95.
custid Subscription Customer Identification Number.
invoice_num Subscription Invoice Number
description Subscription Description

eCheck Information
Field Name Description
bank_account_number Checking Account Number
bank_routing_number Checking Routing Number
bank_account_type The type of bank account used for payment of the subscription.
Accepts values of "checking", "businessChecking", "savings".
bank_name The name of the bank associated with the bank account number
bank_account_name The full name of the individual associated with the bank account.
echeck_type

The type of electronic check transaction used for the subscription.

Accepts values of "PPD" or "WEB" for checking or savings accounts.

Accepts the value of "CCD" for business checking accounts.
drivers_license_number 4 The customer’s driver’s license number
drivers_license_state 4 The customer's driver’s license state
drivers_license_dob 4 The customer’s driver’s license date of birth
customer_organization_type 3 The type of customer. Accepts values of "individual" or "business"
customer_ssn 3 The customer’s tax ID or social security number

3 Required when the merchant is in the Wells Fargo SecureSource program AND the payment method is bank account.

4 Driver’s license information is only required when the merchant is in the Wells Fargo SecureSource program,
 the payment method is bank account, AND tax ID is blank.