Class: ActiveMerchant::Billing::AuthorizeNetCimGateway
- 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
-
Log into the Merchant Interface
-
Select Settings from the Main Menu
-
Click on API Login ID and Transaction Key in the Security section
-
Type in the answer to the secret question configured on setup
-
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_profile_ids => 'getCustomerProfileIds', :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' }
- 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
Instance Attribute Summary
Attributes inherited from Gateway
Instance Method Summary collapse
-
#create_customer_payment_profile(options) ⇒ Object
Creates a new customer payment profile for an existing customer profile.
-
#create_customer_profile(options) ⇒ Object
Creates a new customer profile along with any customer payment profiles and customer shipping addresses for the customer profile.
-
#create_customer_profile_transaction(options) ⇒ Object
Creates a new payment transaction from an existing customer profile.
-
#create_customer_shipping_address(options) ⇒ Object
Creates a new customer shipping address for an existing customer profile.
-
#delete_customer_payment_profile(options) ⇒ Object
Deletes a customer payment profile from an existing customer profile.
-
#delete_customer_profile(options) ⇒ Object
Deletes an existing customer profile along with all associated customer payment profiles and customer shipping addresses.
-
#delete_customer_shipping_address(options) ⇒ Object
Deletes a customer shipping address from an existing customer profile.
-
#get_customer_payment_profile(options) ⇒ Object
Retrieve a customer payment profile for an existing customer profile.
-
#get_customer_profile(options) ⇒ Object
Retrieves an existing customer profile along with all the associated customer payment profiles and customer shipping addresses.
-
#get_customer_profile_ids ⇒ Object
Retrieves a list of all Customer Profile IDs from the gateway.
-
#get_customer_shipping_address(options) ⇒ Object
Retrieve a customer shipping address for an existing customer profile.
-
#initialize(options = {}) ⇒ AuthorizeNetCimGateway
constructor
Creates a new AuthorizeNetCimGateway.
-
#purchase(money, billing_id) ⇒ Object
Run an auth and capture transaction against the stored CC.
-
#store(creditcard, options = {}) ⇒ Object
Create a payment profile.
-
#unstore(billing_id) ⇒ Object
Destroy a customer profile.
-
#update(billing_id, creditcard, options = {}) ⇒ Object
Update an existing payment profile.
-
#update_customer_payment_profile(options) ⇒ Object
Updates a customer payment profile for an existing customer profile.
-
#update_customer_profile(options) ⇒ Object
Updates an existing customer profile.
-
#update_customer_shipping_address(options) ⇒ Object
Updates a customer shipping address for an existing customer profile.
-
#validate_customer_payment_profile(options) ⇒ Object
Verifies an existing customer payment profile by generating a test transaction.
Methods inherited from Gateway
#card_brand, card_brand, inherited, supports?, #test?
Methods included from Utils
Methods included from CreditCardFormatting
Methods included from RequiresParameters
Methods included from PostsData
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
orfalse
. 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( = {}) requires!(, :login, :password) @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)
185 186 187 188 189 190 191 192 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 185 def create_customer_payment_profile() requires!(, :customer_profile_id) requires!(, :payment_profile) requires!([:payment_profile], :payment) request = build_request(:create_customer_payment_profile, ) 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
169 170 171 172 173 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 169 def create_customer_profile() # TODO Add requires request = build_request(:create_customer_profile, ) 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
, or:auth_capture
. (REQUIRED) -
:amount
– The amount for the tranaction. Formatted with a decimal. For example “4.95” (REQUIRED) -
: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 use in this transaction. (REQUIRED)
387 388 389 390 391 392 393 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 387 def create_customer_profile_transaction() requires!(, :transaction) requires!([:transaction], :type, :amount, :customer_profile_id, :customer_payment_profile_id) request = build_request(:create_customer_profile_transaction, ) 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)
200 201 202 203 204 205 206 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 200 def create_customer_shipping_address() requires!(, :customer_profile_id) requires!(, :address) request = build_request(:create_customer_shipping_address, ) 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)
226 227 228 229 230 231 232 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 226 def delete_customer_payment_profile() requires!(, :customer_profile_id) requires!(, :customer_payment_profile_id) request = build_request(:delete_customer_payment_profile, ) 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)
213 214 215 216 217 218 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 213 def delete_customer_profile() requires!(, :customer_profile_id) request = build_request(:delete_customer_profile, ) 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)
240 241 242 243 244 245 246 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 240 def delete_customer_shipping_address() requires!(, :customer_profile_id) requires!(, :customer_address_id) request = build_request(:delete_customer_shipping_address, ) 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)
282 283 284 285 286 287 288 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 282 def get_customer_payment_profile() requires!(, :customer_profile_id) requires!(, :customer_payment_profile_id) request = build_request(:get_customer_payment_profile, ) 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)
255 256 257 258 259 260 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 255 def get_customer_profile() requires!(, :customer_profile_id) request = build_request(:get_customer_profile, ) commit(:get_customer_profile, request) end |
#get_customer_profile_ids ⇒ Object
Retrieves a list of all Customer Profile IDs from the gateway
The response’s params contains the list of Customer Profile IDs
Options - none
268 269 270 271 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 268 def get_customer_profile_ids request = build_request(:get_customer_profile_ids) commit(:get_customer_profile_ids, 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)
298 299 300 301 302 303 304 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 298 def get_customer_shipping_address() requires!(, :customer_profile_id) requires!(, :customer_address_id) request = build_request(:get_customer_shipping_address, ) commit(:get_customer_shipping_address, request) end |
#purchase(money, billing_id) ⇒ Object
Run an auth and capture transaction against the stored CC
146 147 148 149 150 151 152 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 146 def purchase(money, billing_id) if (response = get_customer_profile(:customer_profile_id => billing_id)).success? create_customer_profile_transaction(:transaction => { :customer_profile_id => billing_id, :customer_payment_profile_id => response.params['profile']['payment_profiles']['customer_payment_profile_id'], :type => :auth_capture, :amount => amount(money) }) else response end end |
#store(creditcard, options = {}) ⇒ Object
Create a payment profile
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 106 def store(creditcard, = {}) profile = { :payment_profiles => { :payment => { :credit_card => creditcard } } } profile[:payment_profiles][:bill_to] = [:billing_address] if [:billing_address] profile[:ship_to_list] = [:shipping_address] if [:shipping_address] # CIM actually does require a unique ID to be passed in, # either merchant_customer_id or email, so generate it, if necessary if [:billing_id] profile[:merchant_customer_id] = [:billing_id] elsif [:email] profile[:email] = [:email] else profile[:merchant_customer_id] = Digest::SHA1.hexdigest("#{creditcard.number}#{Time.now.to_i}").first(20) end create_customer_profile(:profile => profile) end |
#unstore(billing_id) ⇒ Object
Destroy a customer profile
155 156 157 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 155 def unstore(billing_id) delete_customer_profile(:customer_profile_id => billing_id) end |
#update(billing_id, creditcard, options = {}) ⇒ Object
Update an existing payment profile
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 129 def update(billing_id, creditcard, = {}) if (response = get_customer_profile(:customer_profile_id => billing_id)).success? update_customer_payment_profile( :customer_profile_id => billing_id, :payment_profile => { :customer_payment_profile_id => response.params['profile']['payment_profiles']['customer_payment_profile_id'], :payment => { :credit_card => creditcard } }.merge([:billing_address] ? {:bill_to => [:billing_address]} : {}) ) else response end 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)
341 342 343 344 345 346 347 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 341 def update_customer_payment_profile() requires!(, :customer_profile_id, :payment_profile) requires!([:payment_profile], :customer_payment_profile_id) request = build_request(:update_customer_payment_profile, ) 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)
319 320 321 322 323 324 325 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 319 def update_customer_profile() requires!(, :profile) requires!([:profile], :customer_profile_id) request = build_request(:update_customer_profile, ) 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)
363 364 365 366 367 368 369 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 363 def update_customer_shipping_address() requires!(, :customer_profile_id, :address) requires!([:address], :customer_address_id) request = build_request(:update_customer_shipping_address, ) 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)
406 407 408 409 410 411 |
# File 'lib/active_merchant/billing/gateways/authorize_net_cim.rb', line 406 def validate_customer_payment_profile() requires!(, :customer_profile_id, :customer_payment_profile_id, :validation_mode) request = build_request(:validate_customer_payment_profile, ) commit(:validate_customer_payment_profile, request) end |