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 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_profile_page(request) ⇒ Object
See spec/api_spec.rb for usage examples.
-
#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.
-
#initialize(api_login_id, api_transaction_key, 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_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.
Methods inherited from ApiTransaction
#deserialize, #make_request, #send_request, #serialize
Methods inherited from XmlTransaction
#has_response?, #response, #run, #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, api_transaction_key, options = {}) ⇒ Transaction
Returns a new instance of Transaction.
4 5 6 |
# File 'lib/authorize_net/api/transaction.rb', line 4 def initialize(api_login_id, api_transaction_key, = {}) super 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
207 208 209 |
# File 'lib/authorize_net/api/transaction.rb', line 207 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
172 173 174 |
# File 'lib/authorize_net/api/transaction.rb', line 172 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
34 35 36 |
# File 'lib/authorize_net/api/transaction.rb', line 34 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
91 92 93 |
# File 'lib/authorize_net/api/transaction.rb', line 91 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
55 56 57 |
# File 'lib/authorize_net/api/transaction.rb', line 55 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: Tokenized transactions (e.g. Apple Pay), or PayPal should not be used to create payment profiles.
See spec/api_spec.rb for usage examples
151 152 153 |
# File 'lib/authorize_net/api/transaction.rb', line 151 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
119 120 121 |
# File 'lib/authorize_net/api/transaction.rb', line 119 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
20 21 22 |
# File 'lib/authorize_net/api/transaction.rb', line 20 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: Tokenized transactions (e.g. Apple Pay), or PayPal should not be used to create payment profiles.
See spec/api_spec.rb for usage examples
13 14 15 |
# File 'lib/authorize_net/api/transaction.rb', line 13 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
165 166 167 |
# File 'lib/authorize_net/api/transaction.rb', line 165 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
112 113 114 |
# File 'lib/authorize_net/api/transaction.rb', line 112 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
84 85 86 |
# File 'lib/authorize_net/api/transaction.rb', line 84 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
140 141 142 |
# File 'lib/authorize_net/api/transaction.rb', line 140 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
179 180 181 |
# File 'lib/authorize_net/api/transaction.rb', line 179 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
98 99 100 |
# File 'lib/authorize_net/api/transaction.rb', line 98 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
200 201 202 |
# File 'lib/authorize_net/api/transaction.rb', line 200 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
62 63 64 |
# File 'lib/authorize_net/api/transaction.rb', line 62 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
70 71 72 |
# File 'lib/authorize_net/api/transaction.rb', line 70 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
126 127 128 |
# File 'lib/authorize_net/api/transaction.rb', line 126 def get_customer_shipping_profile(request) make_request(request,GetCustomerShippingAddressResponse,Type::API_GET_CUSTOMER_SHIPPING_PROFILE) end |
#get_hosted_profile_page(request) ⇒ Object
See spec/api_spec.rb for usage examples
186 187 188 |
# File 'lib/authorize_net/api/transaction.rb', line 186 def get_hosted_profile_page(request) make_request(request,GetHostedProfilePageResponse,Type::API_GET_HOSTED_PROFILE_PAGE) 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
48 49 50 |
# File 'lib/authorize_net/api/transaction.rb', line 48 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
41 42 43 |
# File 'lib/authorize_net/api/transaction.rb', line 41 def get_subscription_status(request) make_request(request,ARBGetSubscriptionStatusResponse,Type::API_GET_SUBSCRIPTION_STATUS) 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
105 106 107 |
# File 'lib/authorize_net/api/transaction.rb', line 105 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
77 78 79 |
# File 'lib/authorize_net/api/transaction.rb', line 77 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
133 134 135 |
# File 'lib/authorize_net/api/transaction.rb', line 133 def update_customer_shipping_profile(request) make_request(request,UpdateCustomerShippingAddressResponse,Type::API_UPDATE_CUSTOMER_SHIPPING_PROFILE) end |
#update_split_tender_group(request) ⇒ Object
This request enables you to update split tender group
See spec/api_spec.rb for usage examples
193 194 195 |
# File 'lib/authorize_net/api/transaction.rb', line 193 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
27 28 29 |
# File 'lib/authorize_net/api/transaction.rb', line 27 def update_subscription(request) make_request(request,ARBUpdateSubscriptionResponse,Type::API_UPDATE_SUBSCRIPTION) end |