Class: ActiveMerchant::Billing::AuthorizeNetCimGateway

Inherits:
Gateway
  • Object
show all
Defined in:
lib/active_merchant/billing/gateways/authorize_net_cim.rb

Overview

Customer Information Manager (CIM)

The Authorize.Net Customer Information Manager (CIM) is an optional additional service that allows you to store sensitive payment information on Authorize.Net’s servers, simplifying payments for returning customers and recurring transactions. It can also help with Payment Card Industry (PCI) Data Security Standard compliance, since customer data is no longer stored locally.

To use the AuthorizeNetCimGateway CIM must be enabled for your account.

Information about CIM is available on the Authorize.Net website. Information about the CIM API is available at the Authorize.Net Integration Center

Login and Password

The login and password are not the username and password you use to login to the Authorize.Net Merchant Interface. Instead, you will use the API Login ID as the login and Transaction Key as the password.

How to Get Your API Login ID and Transaction Key

  1. Log into the Merchant Interface

  2. Select Settings from the Main Menu

  3. Click on API Login ID and Transaction Key in the Security section

  4. Type in the answer to the secret question configured on setup

  5. Click Submit

Constant Summary collapse

AUTHORIZE_NET_CIM_NAMESPACE = 
'AnetApi/xml/v1/schema/AnetApiSchema.xsd'
CIM_ACTIONS = 
{
  :create_customer_profile => 'createCustomerProfile',
  :create_customer_payment_profile => 'createCustomerPaymentProfile',
  :create_customer_shipping_address => 'createCustomerShippingAddress',
  :get_customer_profile => 'getCustomerProfile',
  :get_customer_payment_profile => 'getCustomerPaymentProfile',
  :get_customer_shipping_address => 'getCustomerShippingAddress',
  :delete_customer_profile => 'deleteCustomerProfile',
  :delete_customer_payment_profile => 'deleteCustomerPaymentProfile',
  :delete_customer_shipping_address => 'deleteCustomerShippingAddress',
  :update_customer_profile => 'updateCustomerProfile',
  :update_customer_payment_profile => 'updateCustomerPaymentProfile',
  :update_customer_shipping_address => 'updateCustomerShippingAddress',
  :create_customer_profile_transaction => 'createCustomerProfileTransaction',
  :validate_customer_payment_profile => 'validateCustomerPaymentProfile'
}
CIM_TRANSACTION_TYPES = 
{
  :auth_capture => 'profileTransAuthCapture',
  :auth_only => 'profileTransAuthOnly',
  :capture_only => 'profileTransCaptureOnly',
  :prior_auth_capture => 'profileTransPriorAuthCapture',
  :refund => 'profileTransRefund',
  :void => 'profileTransVoid'
}
CIM_VALIDATION_MODES = 
{
  :none => 'none',
  :test => 'testMode',
  :live => 'liveMode'
}
BANK_ACCOUNT_TYPES = 
{
  :checking => 'checking',
  :savings => 'savings',
  :business_checking => 'businessChecking'
}
ECHECK_TYPES = 
{
  :ccd => 'CCD',
  :ppd => 'PPD'
}

Constants inherited from Gateway

Gateway::DEBIT_CARDS

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary collapse

Methods inherited from Gateway

#card_brand, card_brand, inherited, supports?, #test?

Methods included from Utils

generate_unique_id

Methods included from CreditCardFormatting

#format

Methods included from RequiresParameters

#requires!

Methods included from PostsData

included, #ssl_get, #ssl_post

Constructor Details

#initialize(options = {}) ⇒ AuthorizeNetCimGateway

Creates a new AuthorizeNetCimGateway

The gateway requires that a valid API Login ID and Transaction Key be passed in the options hash.

Options

  • :login – The Authorize.Net API Login ID (REQUIRED)

  • :password – The Authorize.Net Transaction Key. (REQUIRED)

  • :test – true or false. If true, perform transactions against the test server. Otherwise, perform transactions against the production server.



96
97
98
99
100
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 96

def initialize(options = {})
  requires!(options, :login, :password)
  @options = options
  super
end

Instance Method Details

#create_customer_payment_profile(options) ⇒ Object

Creates a new customer payment profile for an existing customer profile.

Options

  • :customer_profile_id – The Customer Profile ID of the customer the payment profile will be added to. (REQUIRED)

  • :payment_profile – A hash containing the elements of the new payment profile (REQUIRED)

Payment Profile

  • :payment – A hash containing information on payment. Either :credit_card or :bank_account (REQUIRED)



128
129
130
131
132
133
134
135
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 128

def create_customer_payment_profile(options)
  requires!(options, :customer_profile_id)
  requires!(options, :payment_profile)
  requires!(options[:payment_profile], :payment)
  
  request = build_request(:create_customer_payment_profile, options)
  commit(:create_customer_payment_profile, request)
end

#create_customer_profile(options) ⇒ Object

Creates a new customer profile along with any customer payment profiles and customer shipping addresses for the customer profile.

Returns a Response with the Customer Profile ID of the new customer profile in the authorization field. It is CRITICAL that you save this ID. There is no way to retrieve this through the API. You will not be able to create another Customer Profile with the same information.

Options

TODO



112
113
114
115
116
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 112

def create_customer_profile(options)
  # TODO Add requires
  request = build_request(:create_customer_profile, options)
  commit(:create_customer_profile, request)
end

#create_customer_profile_transaction(options) ⇒ Object

Creates a new payment transaction from an existing customer profile

This is what is used to charge a customer whose information you have stored in a Customer Profile.

Returns a Response object that contains the result of the transaction in params['direct_response']

Options

  • :transaction – A hash containing information on the transaction that is being requested. (REQUIRED)

Transaction

  • :type – The type of transaction. Can be either :auth_only, :capture_only, :auth_capture, :prior_auth_capture, :refund or :void. (REQUIRED)

  • :amount – The amount for the tranaction. Formatted with a decimal. For example “4.95” (CONDITIONAL)

    - :type == :void (NOT USED)
- :type == (:refund, :auth_only, :capture_only, :auth_capture, :prior_auth_capture) (REQUIRED)

  • :customer_profile_id – The Customer Profile ID of the customer to use in this transaction. (CONDITIONAL)

    - :type == (:void, :prior_auth_capture) (OPTIONAL)
- :type == :refund (CONDITIONAL - required if masked information is not being submitted [see below])
- :type == (:auth_only, :capture_only, :auth_capture) (REQUIRED)

  • :customer_payment_profile_id – The Customer Payment Profile ID of the Customer Payment Profile to use in this transaction. (CONDITIONAL)

    - :type == (:void, :prior_auth_capture) (OPTIONAL)
- :type == :refund (CONDITIONAL - required if masked information is not being submitted [see below])
- :type == (:auth_only, :capture_only, :auth_capture) (REQUIRED)

  • :trans_id – The payment gateway assigned transaction ID of the original transaction (CONDITIONAL):

    - :type = (:void, :refund, :prior_auth_capture) (REQUIRED)
- :type = (:auth_only, :capture_only, :auth_capture) (NOT USED)

  • customer_shipping_address_id – Payment gateway assigned ID associated with the customer shipping address (CONDITIONAL)

    - :type = (:void, :refund) (OPTIONAL)
- :type = (:auth_only, :capture_only, :auth_capture) (NOT USED)
- :type = (:prior_auth_capture) (OPTIONAL)

For :type == :refund only

  • :credit_card_number_masked – (CONDITIONAL - requied for credit card refunds is :customer_profile_id AND :customer_payment_profile_id are missing)

  • :bank_routing_number_masked && :bank_account_number_masked – (CONDITIONAL - requied for electronic check refunds is :customer_profile_id AND :customer_payment_profile_id are missing) (NOT ABLE TO TEST - I keep getting “ACH transactions are not accepted by this merchant.” when trying to make a payment and, until that’s possible I can’t refund ([email protected]))



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 342

def create_customer_profile_transaction(options)
  requires!(options, :transaction)
  requires!(options[:transaction], :type)
  case options[:transaction][:type]
    when :void
      requires!(options[:transaction], :trans_id)
    when :refund
      requires!(options[:transaction], :trans_id) &&
        (
          (options[:transaction][:customer_profile_id] && options[:transaction][:customer_payment_profile_id]) ||
          options[:transaction][:credit_card_number_masked] ||
          (options[:transaction][:bank_routing_number_masked] && options[:transaction][:bank_account_number_masked])
        )
    when :prior_auth_capture
      requires!(options[:transaction], :amount, :trans_id)
    else
      requires!(options[:transaction], :amount, :customer_profile_id, :customer_payment_profile_id)
  end
  request = build_request(:create_customer_profile_transaction, options)
  commit(:create_customer_profile_transaction, request)
end

#create_customer_profile_transaction_for_refund(options) ⇒ Object

Creates a new payment transaction for refund from an existing customer profile

This is what is used to refund a transaction you have stored in a Customer Profile.

Returns a Response object that contains the result of the transaction in params['direct_response']

Options

  • :transaction – A hash containing information on the transaction that is being requested. (REQUIRED)

Transaction

  • :amount – The total amount to be refunded (REQUIRED)

  • :customer_profile_id – The Customer Profile ID of the customer to use in this transaction. (CONDITIONAL :customer_payment_profile_id must be included if used)

  • :customer_payment_profile_id – The Customer Payment Profile ID of the Customer Payment Profile to use in this transaction. (CONDITIONAL :customer_profile_id must be included if used)

  • :credit_card_number_masked – Four Xs follwed by the last four digits of the credit card (CONDITIONAL - used if customer_profile_id and customer_payment_profile_id aren’t given)

  • :bank_routing_number_masked – The last four gidits of the routing number to be refunded (CONDITIONAL - must be used with :bank_account_number_masked)

  • :bank_account_number_masked – The last four digis of the bank account number to be refunded, Ex. XXXX1234 (CONDITIONAL - must be used with :bank_routing_number_masked)



385
386
387
388
389
390
391
392
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 385

def create_customer_profile_transaction_for_refund(options)
  requires!(options, :transaction)
  options[:transaction][:type] = :refund
  requires!(options[:transaction], :trans_id)
  requires!(options[:transaction], :amount)
  request = build_request(:create_customer_profile_transaction, options)
  commit(:create_customer_profile_transaction, request)
end

#create_customer_profile_transaction_for_void(options) ⇒ Object

Creates a new payment transaction for void from an existing customer profile

This is what is used to void a transaction you have stored in a Customer Profile.

Returns a Response object that contains the result of the transaction in params['direct_response']

Options

  • :transaction – A hash containing information on the transaction that is being requested. (REQUIRED)

Transaction

  • :trans_id – The payment gateway assigned transaction id of the original transaction. (REQUIRED)

  • :customer_profile_id – The Customer Profile ID of the customer to use in this transaction.

  • :customer_payment_profile_id – The Customer Payment Profile ID of the Customer Payment Profile to use in this transaction.

  • :customer_shipping_address_id – Payment gateway assigned ID associated with the customer shipping address.



410
411
412
413
414
415
416
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 410

def create_customer_profile_transaction_for_void(options)
  requires!(options, :transaction)
  options[:transaction][:type] = :void
  requires!(options[:transaction], :trans_id)
  request = build_request(:create_customer_profile_transaction, options)
  commit(:create_customer_profile_transaction, request)
end

#create_customer_shipping_address(options) ⇒ Object

Creates a new customer shipping address for an existing customer profile.

Options

  • :customer_profile_id – The Customer Profile ID of the customer the payment profile will be added to. (REQUIRED)

  • :address – A hash containing the elements of the shipping address (REQUIRED)



143
144
145
146
147
148
149
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 143

def create_customer_shipping_address(options)
  requires!(options, :customer_profile_id)
  requires!(options, :address)
  
  request = build_request(:create_customer_shipping_address, options)
  commit(:create_customer_shipping_address, request)
end

#delete_customer_payment_profile(options) ⇒ Object

Deletes a customer payment profile from an existing customer profile.

Options

  • :customer_profile_id – The Customer Profile ID of the customer with the payment profile to be deleted. (REQUIRED)

  • :customer_payment_profile_id – The Payment Profile ID of the payment profile to be deleted. (REQUIRED)



169
170
171
172
173
174
175
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 169

def delete_customer_payment_profile(options)
  requires!(options, :customer_profile_id)
  requires!(options, :customer_payment_profile_id)

  request = build_request(:delete_customer_payment_profile, options)
  commit(:delete_customer_payment_profile, request)
end

#delete_customer_profile(options) ⇒ Object

Deletes an existing customer profile along with all associated customer payment profiles and customer shipping addresses.

Options

  • :customer_profile_id – The Customer Profile ID of the customer to be deleted. (REQUIRED)



156
157
158
159
160
161
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 156

def delete_customer_profile(options)
  requires!(options, :customer_profile_id)

  request = build_request(:delete_customer_profile, options)
  commit(:delete_customer_profile, request)
end

#delete_customer_shipping_address(options) ⇒ Object

Deletes a customer shipping address from an existing customer profile.

Options

  • :customer_profile_id – The Customer Profile ID of the customer with the payment profile to be deleted. (REQUIRED)

  • :customer_address_id – The Shipping Address ID of the shipping address to be deleted. (REQUIRED)



183
184
185
186
187
188
189
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 183

def delete_customer_shipping_address(options)
  requires!(options, :customer_profile_id)
  requires!(options, :customer_address_id)

  request = build_request(:delete_customer_shipping_address, options)
  commit(:delete_customer_shipping_address, request)
end

#get_customer_payment_profile(options) ⇒ Object

Retrieve a customer payment profile for an existing customer profile.

Returns a Response whose params hash contains all the payment profile information. Sensitive information such as credit card numbers will be masked.

Options

  • :customer_profile_id – The Customer Profile ID of the customer with the payment profile to be retrieved. (REQUIRED)

  • :customer_payment_profile_id – The Payment Profile ID of the payment profile to be retrieved. (REQUIRED)



214
215
216
217
218
219
220
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 214

def get_customer_payment_profile(options)
  requires!(options, :customer_profile_id)
  requires!(options, :customer_payment_profile_id)

  request = build_request(:get_customer_payment_profile, options)
  commit(:get_customer_payment_profile, request)
end

#get_customer_profile(options) ⇒ Object

Retrieves an existing customer profile along with all the associated customer payment profiles and customer shipping addresses.

Returns a Response whose params hash contains all the profile information.

Options

  • :customer_profile_id – The Customer Profile ID of the customer to retrieve. (REQUIRED)



198
199
200
201
202
203
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 198

def get_customer_profile(options)
  requires!(options, :customer_profile_id)

  request = build_request(:get_customer_profile, options)
  commit(:get_customer_profile, request)
end

#get_customer_shipping_address(options) ⇒ Object

Retrieve a customer shipping address for an existing customer profile.

Returns a Response whose params hash contains all the shipping address information.

Options

  • :customer_profile_id – The Customer Profile ID of the customer with the payment profile to be retrieved. (REQUIRED)

  • :customer_address_id – The Shipping Address ID of the shipping address to be retrieved. (REQUIRED)



230
231
232
233
234
235
236
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 230

def get_customer_shipping_address(options)
  requires!(options, :customer_profile_id)
  requires!(options, :customer_address_id)

  request = build_request(:get_customer_shipping_address, options)
  commit(:get_customer_shipping_address, request)
end

#update_customer_payment_profile(options) ⇒ Object

Updates a customer payment profile for an existing customer profile.

Warning: if you do not provide a parameter in the :payment_profile hash, it is automatically set to nil at Authorize.Net. You will most likely want to first get the profile hash using get_customer_payment_profile and then only change the elements you wish to change.

Options

  • :customer_profile_id – The Customer Profile ID of the customer with the payment profile to be updated. (REQUIRED)

  • :payment_profile – A hash containing the values the Customer Payment Profile should be updated to. (REQUIRED)

Payment Profile

  • :customer_payment_profile_id – The Customer Payment Profile ID of the Customer Payment Profile to update. (REQUIRED)



273
274
275
276
277
278
279
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 273

def update_customer_payment_profile(options)
  requires!(options, :customer_profile_id, :payment_profile)
  requires!(options[:payment_profile], :customer_payment_profile_id)

  request = build_request(:update_customer_payment_profile, options)
  commit(:update_customer_payment_profile, request)
end

#update_customer_profile(options) ⇒ Object

Updates an existing customer profile.

Warning: if you do not provide a parameter in the :payment_profile hash, it is automatically set to nil at Authorize.Net. You will most likely want to first get the profile hash using get_customer_profile and then only change the elements you wish to change.

Options

  • :profile – A hash containing the values the Customer Profile should be updated to. (REQUIRED)

Profile

  • :customer_profile_id – The Customer Profile ID of the customer profile to update. (REQUIRED)



251
252
253
254
255
256
257
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 251

def update_customer_profile(options)
  requires!(options, :profile)
  requires!(options[:profile], :customer_profile_id)

  request = build_request(:update_customer_profile, options)
  commit(:update_customer_profile, request)
end

#update_customer_shipping_address(options) ⇒ Object

Updates a customer shipping address for an existing customer profile.

Warning: if you do not provide a parameter in the :address hash, it is automatically set to nil at Authorize.Net. You will most likely want to first get the profile hash using get_customer_shipping_address and then only change the elements you wish to change.

Options

  • :customer_profile_id – The Customer Profile ID of the customer with the payment profile to be updated. (REQUIRED)

  • :address – A hash containing the values the Customer Shipping Address should be updated to. (REQUIRED)

Address

  • :customer_address_id – The Customer Address ID of the Customer Payment Profile to update. (REQUIRED)



295
296
297
298
299
300
301
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 295

def update_customer_shipping_address(options)
  requires!(options, :customer_profile_id, :address)
  requires!(options[:address], :customer_address_id)

  request = build_request(:update_customer_shipping_address, options)
  commit(:update_customer_shipping_address, request)
end

#validate_customer_payment_profile(options) ⇒ Object

Verifies an existing customer payment profile by generating a test transaction

Returns a Response object that contains the result of the transaction in params['direct_response']

Options

  • :customer_profile_id – The Customer Profile ID of the customer to use in this transaction. (REQUIRED)

  • :customer_payment_profile_id – The Customer Payment Profile ID of the Customer Payment Profile to be verified. (REQUIRED)

  • :customer_address_id – The Customer Address ID of the Customer Shipping Address to be verified.

  • :validation_mode – :live or :test In Test Mode, only field validation is performed. In Live Mode, a transaction is generated and submitted to the processor with the amount of $0.01. If successful, the transaction is immediately voided. (REQUIRED)



429
430
431
432
433
434
 
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 429

def validate_customer_payment_profile(options)
  requires!(options, :customer_profile_id, :customer_payment_profile_id, :validation_mode)

  request = build_request(:validate_customer_payment_profile, options)
  commit(:validate_customer_payment_profile, request)
end