Class: AuthorizeNet::API::Transaction
- Inherits:
-
ApiTransaction
- Object
- Transaction
- XmlTransaction
- ApiTransaction
- AuthorizeNet::API::Transaction
- Defined in:
- lib/authorize_net/api/transaction.rb
Constant Summary
Constants inherited from XmlTransaction
Constants included from TypeConversions
TypeConversions::API_FIELD_PREFIX
Instance Attribute Summary collapse
-
#access_token ⇒ Object
Returns the value of attribute access_token.
-
#options_OAuth ⇒ Object
Returns the value of attribute options_OAuth.
Instance Method Summary collapse
-
#arb_get_subscription_request(request) ⇒ Object
This request enables you to get ARB Subscription.
-
#authenticate_test_request(request) ⇒ Object
This request enables confirm authentication values.
-
#cancel_subscription(request) ⇒ Object
This request enables you to cancel a recurring billing subscription.
-
#create_customer_payment_profile(request) ⇒ Object
This request enables you to create a customer payment profile.
-
#create_customer_profile(request) ⇒ Object
This request enables you to create a customer profile.
-
#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.
-
#create_customer_shipping_profile(request) ⇒ Object
This request enables you to create a customer shipping profile.
-
#create_subscription(request) ⇒ Object
This request enables you to create a recurring billing subscription.
-
#create_transaction(request) ⇒ Object
This request enables you to create a transaction, and optional customer profile.
-
#decrypt_payment_data(request) ⇒ Object
This request enables you to decrypt a payment data blob.
-
#delete_customer_payment_profile(request) ⇒ Object
This request enables you to delete a customer payment profile.
-
#delete_customer_profile(request) ⇒ Object
This request enables you to delete a customer profile.
-
#delete_customer_shipping_profile(request) ⇒ Object
This request enables you to delete a customer shipping profile.
-
#get_batch_statistics(request) ⇒ Object
This request enables you to get batch statistics details.
-
#get_customer_payment_profile(request) ⇒ Object
This request enables you to retrieve a customer payment profile.
-
#get_customer_payment_profile_list(request) ⇒ Object
This request enables you to get customer payment profile list.
-
#get_customer_profile(request) ⇒ Object
This request enables you to retrieve a customer profile.
-
#get_customer_profile_ids(request) ⇒ Object
This request enables you to retrieve all customer profile IDs.
-
#get_customer_shipping_profile(request) ⇒ Object
This request enables you to retrieve a customer shipping profile.
- #get_hosted_payment_page(request) ⇒ Object
-
#get_hosted_profile_page(request) ⇒ Object
See spec/api_spec.rb for usage examples.
- #get_merchant_details(request) ⇒ Object
-
#get_settled_batch_list(request) ⇒ Object
This request enables you to get batch settled transaction details.
-
#get_subscription_list(request) ⇒ Object
This request enables you to get a list of all recurring billing subscriptions.
-
#get_subscription_status(request) ⇒ Object
This request enables you to get a recurring billing subscription status.
-
#get_transaction_details(request) ⇒ Object
This request enables you to get batch transaction details.
-
#get_transaction_list(request) ⇒ Object
This request enables you to get transaction list.
- #get_transaction_list_for_customer(request) ⇒ Object
-
#get_unsettled_transaction_list(request) ⇒ Object
This request enables you to get batch unsettled transaction details.
-
#initialize(api_login_id = nil, api_transaction_key = nil, options = {}) ⇒ Transaction
constructor
A new instance of Transaction.
-
#update_customer_payment_profile(request) ⇒ Object
This request enables you to update a customer payment profile.
-
#update_customer_profile(request) ⇒ Object
This request enables you to update a customer profile.
-
#update_customer_shipping_profile(request) ⇒ Object
This request enables you to update a customer shipping profile.
- #update_held_transaction(request) ⇒ Object
- #update_merchant_details(request) ⇒ Object
-
#update_split_tender_group(request) ⇒ Object
This request enables you to update split tender group.
-
#update_subscription(request) ⇒ Object
This request enables you to update a recurring billing subscription.
-
#validate_customer_payment_profile(request) ⇒ Object
This request enables you to validate customer payment profile.
Methods inherited from ApiTransaction
#deserialize, #make_request, #send_request, #serialize, #setOAuthOptions
Methods inherited from XmlTransaction
#has_response?, #response, #run, #setOAuthOptions, #test?, #xml
Methods inherited from Transaction
#fields, #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(api_login_id = nil, api_transaction_key = nil, = {}) 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 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
225 226 227 |
# File 'lib/authorize_net/api/transaction.rb', line 225 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
169 170 171 |
# File 'lib/authorize_net/api/transaction.rb', line 169 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
95 96 97 |
# File 'lib/authorize_net/api/transaction.rb', line 95 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
155 156 157 |
# File 'lib/authorize_net/api/transaction.rb', line 155 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
123 124 125 |
# File 'lib/authorize_net/api/transaction.rb', line 123 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
162 163 164 |
# File 'lib/authorize_net/api/transaction.rb', line 162 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
116 117 118 |
# File 'lib/authorize_net/api/transaction.rb', line 116 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
88 89 90 |
# File 'lib/authorize_net/api/transaction.rb', line 88 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
144 145 146 |
# File 'lib/authorize_net/api/transaction.rb', line 144 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
176 177 178 |
# File 'lib/authorize_net/api/transaction.rb', line 176 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
102 103 104 |
# File 'lib/authorize_net/api/transaction.rb', line 102 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
218 219 220 |
# File 'lib/authorize_net/api/transaction.rb', line 218 def get_customer_payment_profile_list(request) make_request(request,GetCustomerPaymentProfileListResponse,Type::API_GET_CUSTOMER_PAYMENT_PROFILE_LIST) 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
74 75 76 |
# File 'lib/authorize_net/api/transaction.rb', line 74 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
130 131 132 |
# File 'lib/authorize_net/api/transaction.rb', line 130 def get_customer_shipping_profile(request) make_request(request,GetCustomerShippingAddressResponse,Type::API_GET_CUSTOMER_SHIPPING_PROFILE) end |
#get_hosted_payment_page(request) ⇒ Object
247 248 249 |
# File 'lib/authorize_net/api/transaction.rb', line 247 def get_hosted_payment_page(request) make_request(request,GetHostedPaymentPageResponse,Type::API_GET_HOSTED_PAYMENT_PAGE) end |
#get_hosted_profile_page(request) ⇒ Object
See spec/api_spec.rb for usage examples
204 205 206 |
# File 'lib/authorize_net/api/transaction.rb', line 204 def get_hosted_profile_page(request) make_request(request,GetHostedProfilePageResponse,Type::API_GET_HOSTED_PROFILE_PAGE) end |
#get_merchant_details(request) ⇒ Object
243 244 245 |
# File 'lib/authorize_net/api/transaction.rb', line 243 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
190 191 192 |
# File 'lib/authorize_net/api/transaction.rb', line 190 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
183 184 185 |
# File 'lib/authorize_net/api/transaction.rb', line 183 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
232 233 234 |
# File 'lib/authorize_net/api/transaction.rb', line 232 def get_transaction_list(request) make_request(request,GetTransactionListResponse,Type::API_GET_TRANSACTION_LIST) end |
#get_transaction_list_for_customer(request) ⇒ Object
255 256 257 |
# File 'lib/authorize_net/api/transaction.rb', line 255 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
197 198 199 |
# File 'lib/authorize_net/api/transaction.rb', line 197 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
109 110 111 |
# File 'lib/authorize_net/api/transaction.rb', line 109 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
81 82 83 |
# File 'lib/authorize_net/api/transaction.rb', line 81 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
137 138 139 |
# File 'lib/authorize_net/api/transaction.rb', line 137 def update_customer_shipping_profile(request) make_request(request,UpdateCustomerShippingAddressResponse,Type::API_UPDATE_CUSTOMER_SHIPPING_PROFILE) end |
#update_held_transaction(request) ⇒ Object
251 252 253 |
# File 'lib/authorize_net/api/transaction.rb', line 251 def update_held_transaction(request) make_request(request,UpdateHeldTransactionResponse,Type::API_UDPATE_HELD_TRANSACTION) end |
#update_merchant_details(request) ⇒ Object
259 260 261 |
# File 'lib/authorize_net/api/transaction.rb', line 259 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
211 212 213 |
# File 'lib/authorize_net/api/transaction.rb', line 211 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
239 240 241 |
# File 'lib/authorize_net/api/transaction.rb', line 239 def validate_customer_payment_profile(request) make_request(request,ValidateCustomerPaymentProfileResponse,Type::API_VALIDATE_CUSTOMER_PAYMENT_PROFILE) end |