Class: AuthorizeNet::API::Transaction

Inherits:
ApiTransaction show all
Defined in:
lib/authorize_net/api/transaction.rb

Constant Summary

Constants inherited from XmlTransaction

XmlTransaction::XML_NAMESPACE

Constants included from TypeConversions

TypeConversions::API_FIELD_PREFIX

Instance Attribute Summary collapse

Attributes inherited from XmlTransaction

#response, #xml

Attributes inherited from Transaction

#fields

Instance Method Summary collapse

Methods inherited from ApiTransaction

#deserialize, #make_request, #send_request, #serialize, #setOAuthOptions

Methods inherited from XmlTransaction

#has_response?, #run, #setOAuthOptions, #test?

Methods inherited from Transaction

#set_address, #set_customer, #set_fields, #set_shipping_address

Methods included from TypeConversions

#boolean_to_value, #date_to_value, #datetime_to_value, #decimal_to_value, #integer_to_value, #to_external_field, #to_internal_field, #to_param, #value_to_boolean, #value_to_date, #value_to_datetime, #value_to_decimal, #value_to_integer

Constructor Details

#initialize(api_login_id = nil, api_transaction_key = nil, options = {}) ⇒ Transaction

Returns a new instance of Transaction.



6
7
8
 
# File 'lib/authorize_net/api/transaction.rb', line 6

def initialize( = nil, api_transaction_key = nil, options = {})
  super
end

Instance Attribute Details

#access_token ⇒ Object

Returns the value of attribute access_token.



3
4
5
 
# File 'lib/authorize_net/api/transaction.rb', line 3

def access_token
  @access_token
end

#options_OAuth ⇒ Object

Returns the value of attribute options_OAuth.



4
5
6
 
# File 'lib/authorize_net/api/transaction.rb', line 4

def options_OAuth
  @options_OAuth
end

Instance Method Details

#arb_get_subscription_request(request) ⇒ Object

This request enables you to get ARB Subscription.

See spec/api_spec.rb for usage examples



223
224
225
 
# File 'lib/authorize_net/api/transaction.rb', line 223

def arb_get_subscription_request(request)
  make_request(request, ARBGetSubscriptionResponse, Type::API_ARB_GET_SUBSCRIPTION_REQUEST)
end

#authenticate_test_request(request) ⇒ Object

This request enables confirm authentication values.

See spec/api_spec.rb for usage examples



167
168
169
 
# File 'lib/authorize_net/api/transaction.rb', line 167

def authenticate_test_request(request)
  make_request(request, AuthenticateTestResponse, Type::API_AUTHENTICATE_TEST_REQUEST)
end

#cancel_subscription(request) ⇒ Object

This request enables you to cancel a recurring billing subscription.

See spec/api_spec.rb for usage examples



37
38
39
 
# File 'lib/authorize_net/api/transaction.rb', line 37

def cancel_subscription(request)
  make_request(request, ARBCancelSubscriptionResponse, Type::API_CANCEL_SUBSCRIPTION)
end

#create_customer_payment_profile(request) ⇒ Object

This request enables you to create a customer payment profile.

See spec/api_spec.rb for usage examples



94
95
96
 
# File 'lib/authorize_net/api/transaction.rb', line 94

def create_customer_payment_profile(request)
  make_request(request, CreateCustomerPaymentProfileResponse, Type::API_CREATE_CUSTOMER_PAYMENT_PROFILE)
end

#create_customer_profile(request) ⇒ Object

This request enables you to create a customer profile.

See spec/api_spec.rb for usage examples



59
60
61
 
# File 'lib/authorize_net/api/transaction.rb', line 59

def create_customer_profile(request)
  make_request(request, CreateCustomerProfileResponse, Type::API_CREATE_CUSTOMER_PROFILE)
end

#create_customer_profile_from_transaction(request) ⇒ Object

This request enables you to create a customer profile, payment profile, and shipping profile from an existing successful transaction. NOTE: Network tokenized transactions (e.g. Apple Pay), or PayPal should not be used to create payment profiles.

See spec/api_spec.rb for usage examples



153
154
155
 
# File 'lib/authorize_net/api/transaction.rb', line 153

def create_customer_profile_from_transaction(request)
  make_request(request, CreateProfileResponse, Type::API_CREATE_CUSTOMER_PROFILE_FROM_TRANSACTION)
end

#create_customer_shipping_profile(request) ⇒ Object

This request enables you to create a customer shipping profile.

See spec/api_spec.rb for usage examples



122
123
124
 
# File 'lib/authorize_net/api/transaction.rb', line 122

def create_customer_shipping_profile(request)
  make_request(request, CreateCustomerShippingAddressResponse, Type::API_CREATE_CUSTOMER_SHIPPING_PROFILE)
end

#create_subscription(request) ⇒ Object

This request enables you to create a recurring billing subscription.

See spec/api_spec.rb for usage examples



23
24
25
 
# File 'lib/authorize_net/api/transaction.rb', line 23

def create_subscription(request)
  make_request(request, ARBCreateSubscriptionResponse, Type::API_CREATE_SUBSCRIPTION)
end

#create_transaction(request) ⇒ Object

This request enables you to create a transaction, and optional customer profile. NOTE: Network tokenized transactions (e.g. Apple Pay), or PayPal should not be used to create payment profiles.

See spec/api_spec.rb for usage examples



16
17
18
 
# File 'lib/authorize_net/api/transaction.rb', line 16

def create_transaction(request)
  make_request(request, CreateTransactionResponse, Type::API_CREATE_TRANSACTION)
end

#decrypt_payment_data(request) ⇒ Object

This request enables you to decrypt a payment data blob.

See spec/api_spec.rb for usage examples



160
161
162
 
# File 'lib/authorize_net/api/transaction.rb', line 160

def decrypt_payment_data(request)
  make_request(request, DecryptPaymentDataResponse, Type::API_DECRYPT_PAYMENT_DATA)
end

#delete_customer_payment_profile(request) ⇒ Object

This request enables you to delete a customer payment profile.

See spec/api_spec.rb for usage examples



115
116
117
 
# File 'lib/authorize_net/api/transaction.rb', line 115

def delete_customer_payment_profile(request)
  make_request(request, DeleteCustomerPaymentProfileResponse, Type::API_DELETE_CUSTOMER_PAYMENT_PROFILE)
end

#delete_customer_profile(request) ⇒ Object

This request enables you to delete a customer profile.

See spec/api_spec.rb for usage examples



87
88
89
 
# File 'lib/authorize_net/api/transaction.rb', line 87

def delete_customer_profile(request)
  make_request(request, DeleteCustomerProfileResponse, Type::API_DELETE_CUSTOMER_PROFILE)
end

#delete_customer_shipping_profile(request) ⇒ Object

This request enables you to delete a customer shipping profile.

See spec/api_spec.rb for usage examples



143
144
145
 
# File 'lib/authorize_net/api/transaction.rb', line 143

def delete_customer_shipping_profile(request)
  make_request(request, DeleteCustomerShippingAddressResponse, Type::API_DELETE_CUSTOMER_SHIPPING_PROFILE)
end

#get_batch_statistics(request) ⇒ Object

This request enables you to get batch statistics details.

See spec/api_spec.rb for usage examples



174
175
176
 
# File 'lib/authorize_net/api/transaction.rb', line 174

def get_batch_statistics(request)
  make_request(request, GetBatchStatisticsResponse, Type::API_GET_BATCH_STATISTICS)
end

#get_customer_payment_profile(request) ⇒ Object

This request enables you to retrieve a customer payment profile.

See spec/api_spec.rb for usage examples



101
102
103
 
# File 'lib/authorize_net/api/transaction.rb', line 101

def get_customer_payment_profile(request)
  make_request(request, GetCustomerPaymentProfileResponse, Type::API_GET_CUSTOMER_PAYMENT_PROFILE)
end

#get_customer_payment_profile_list(request) ⇒ Object

This request enables you to get customer payment profile list.

See spec/api_spec.rb for usage examples



216
217
218
 
# File 'lib/authorize_net/api/transaction.rb', line 216

def get_customer_payment_profile_list(request)
  make_request(request, GetCustomerPaymentProfileListResponse, Type::API_GET_CUSTOMER_PAYMENT_PROFILE_LIST)
end

#get_customer_payment_profile_nonce(request) ⇒ Object 



261
262
263
 
# File 'lib/authorize_net/api/transaction.rb', line 261

def get_customer_payment_profile_nonce(request)
  make_request(request, GetCustomerPaymentProfileNonceResponse, Type::API_GET_CUSTOMER_PAYMENT_PROFILE_NONCE)
end

#get_customer_profile(request) ⇒ Object

This request enables you to retrieve a customer profile.

See spec/api_spec.rb for usage examples



66
67
68
 
# File 'lib/authorize_net/api/transaction.rb', line 66

def get_customer_profile(request)
  make_request(request, GetCustomerProfileResponse, Type::API_GET_CUSTOMER_PROFILE)
end

#get_customer_profile_ids(request) ⇒ Object

This request enables you to retrieve all customer profile IDs.

See spec/api_spec.rb for usage examples



73
74
75
 
# File 'lib/authorize_net/api/transaction.rb', line 73

def get_customer_profile_ids(request)
  make_request(request, GetCustomerProfileIdsResponse, Type::API_GET_CUSTOMER_PROFILE_IDS)
end

#get_customer_shipping_profile(request) ⇒ Object

This request enables you to retrieve a customer shipping profile.

See spec/api_spec.rb for usage examples



129
130
131
 
# File 'lib/authorize_net/api/transaction.rb', line 129

def get_customer_shipping_profile(request)
  make_request(request, GetCustomerShippingAddressResponse, Type::API_GET_CUSTOMER_SHIPPING_PROFILE)
end

#get_hosted_payment_page(request) ⇒ Object 



245
246
247
 
# File 'lib/authorize_net/api/transaction.rb', line 245

def get_hosted_payment_page(request)
  make_request(request, GetHostedPaymentPageResponse, Type::API_GET_HOSTED_PAYMENT_PAGE)
end

#get_hosted_profile_page(request) ⇒ Object

This request enables confirm authentication values.

See spec/api_spec.rb for usage examples



202
203
204
 
# File 'lib/authorize_net/api/transaction.rb', line 202

def get_hosted_profile_page(request)
  make_request(request, GetHostedProfilePageResponse, Type::API_GET_HOSTED_PROFILE_PAGE)
end

#get_merchant_details(request) ⇒ Object 



241
242
243
 
# File 'lib/authorize_net/api/transaction.rb', line 241

def get_merchant_details(request)
  make_request(request, GetMerchantDetailsResponse, Type::API_GET_MERCHANT_DETAILS)
end

#get_settled_batch_list(request) ⇒ Object

This request enables you to get batch settled transaction details.

See spec/api_spec.rb for usage examples



188
189
190
 
# File 'lib/authorize_net/api/transaction.rb', line 188

def get_settled_batch_list(request)
  make_request(request, GetSettledBatchListResponse, Type::API_GET_SETTLED_BATCH_LIST)
end

#get_subscription_list(request) ⇒ Object

This request enables you to get a list of all recurring billing subscriptions.

See spec/api_spec.rb for usage examples



52
53
54
 
# File 'lib/authorize_net/api/transaction.rb', line 52

def get_subscription_list(request)
  make_request(request, ARBGetSubscriptionListResponse, Type::API_GET_SUBSCRIPTION_LIST)
end

#get_subscription_status(request) ⇒ Object

This request enables you to get a recurring billing subscription status.

See spec/api_spec.rb for usage examples



44
45
46
 
# File 'lib/authorize_net/api/transaction.rb', line 44

def get_subscription_status(request)
  make_request(request, ARBGetSubscriptionStatusResponse, Type::API_GET_SUBSCRIPTION_STATUS)
end

#get_transaction_details(request) ⇒ Object

This request enables you to get batch transaction details.

See spec/api_spec.rb for usage examples



181
182
183
 
# File 'lib/authorize_net/api/transaction.rb', line 181

def get_transaction_details(request)
  make_request(request, GetTransactionDetailsResponse, Type::API_GET_TRANSACTION_DETAILS)
end

#get_transaction_list(request) ⇒ Object

This request enables you to get transaction list.

See spec/api_spec.rb for usage examples



230
231
232
 
# File 'lib/authorize_net/api/transaction.rb', line 230

def get_transaction_list(request)
  make_request(request, GetTransactionListResponse, Type::API_GET_TRANSACTION_LIST)
end

#get_transaction_list_for_customer(request) ⇒ Object 



253
254
255
 
# File 'lib/authorize_net/api/transaction.rb', line 253

def get_transaction_list_for_customer(request)
  make_request(request, GetTransactionListResponse, Type::API_GET_TRANSACTION_LIST_FOR_CUSTOMER)
end

#get_unsettled_transaction_list(request) ⇒ Object

This request enables you to get batch unsettled transaction details.

See spec/api_spec.rb for usage examples



195
196
197
 
# File 'lib/authorize_net/api/transaction.rb', line 195

def get_unsettled_transaction_list(request)
  make_request(request, GetUnsettledTransactionListResponse, Type::API_GET_UNSETTLED_TRANSACTION_LIST)
end

#update_customer_payment_profile(request) ⇒ Object

This request enables you to update a customer payment profile.

See spec/api_spec.rb for usage examples



108
109
110
 
# File 'lib/authorize_net/api/transaction.rb', line 108

def update_customer_payment_profile(request)
  make_request(request, UpdateCustomerPaymentProfileResponse, Type::API_UPDATE_CUSTOMER_PAYMENT_PROFILE)
end

#update_customer_profile(request) ⇒ Object

This request enables you to update a customer profile.

See spec/api_spec.rb for usage examples



80
81
82
 
# File 'lib/authorize_net/api/transaction.rb', line 80

def update_customer_profile(request)
  make_request(request, UpdateCustomerProfileResponse, Type::API_UPDATE_CUSTOMER_PROFILE)
end

#update_customer_shipping_profile(request) ⇒ Object

This request enables you to update a customer shipping profile.

See spec/api_spec.rb for usage examples



136
137
138
 
# File 'lib/authorize_net/api/transaction.rb', line 136

def update_customer_shipping_profile(request)
  make_request(request, UpdateCustomerShippingAddressResponse, Type::API_UPDATE_CUSTOMER_SHIPPING_PROFILE)
end

#update_held_transaction(request) ⇒ Object 



249
250
251
 
# File 'lib/authorize_net/api/transaction.rb', line 249

def update_held_transaction(request)
  make_request(request, UpdateHeldTransactionResponse, Type::API_UDPATE_HELD_TRANSACTION)
end

#update_merchant_details(request) ⇒ Object 



257
258
259
 
# File 'lib/authorize_net/api/transaction.rb', line 257

def update_merchant_details(request)
  make_request(request, UpdateMerchantDetailsResponse, Type::API_UPDATE_MERCHANT_DETAILS)
end

#update_split_tender_group(request) ⇒ Object

This request enables you to update split tender group.

See spec/api_spec.rb for usage examples



209
210
211
 
# File 'lib/authorize_net/api/transaction.rb', line 209

def update_split_tender_group(request)
  make_request(request, UpdateSplitTenderGroupResponse, Type::API_UPDATE_SPLIT_TENDER_GROUP)
end

#update_subscription(request) ⇒ Object

This request enables you to update a recurring billing subscription.

See spec/api_spec.rb for usage examples



30
31
32
 
# File 'lib/authorize_net/api/transaction.rb', line 30

def update_subscription(request)
  make_request(request, ARBUpdateSubscriptionResponse, Type::API_UPDATE_SUBSCRIPTION)
end

#validate_customer_payment_profile(request) ⇒ Object

This request enables you to validate customer payment profile.

See spec/api_spec.rb for usage examples



237
238
239
 
# File 'lib/authorize_net/api/transaction.rb', line 237

def validate_customer_payment_profile(request)
  make_request(request, ValidateCustomerPaymentProfileResponse, Type::API_VALIDATE_CUSTOMER_PAYMENT_PROFILE)
end