Class: MWS::OffAmazonPayments::Client
- Inherits:
-
Peddler::Client
- Object
- Peddler::Client
- MWS::OffAmazonPayments::Client
- Defined in:
- lib/mws/off_amazon_payments/client.rb
Overview
The Off-Amazon Payments API section is only applicable to payments made through the Login and Pay with Amazon service offered by Amazon Payments. You cannot use this API section to process payments for Amazon Marketplace, Amazon Webstore, or Checkout by Amazon.
The Off-Amazon Payments API helps you to process payments for purchases made by buyers on your website using the Login and Pay with Amazon service. This API enables you to programmatically retrieve shipping and payment information provided by the buyer from their Amazon account. It allows you to authorize, capture, and refund payments, enabling a variety of payments scenarios.
Instance Attribute Summary
Attributes inherited from Peddler::Client
#auth_token, #body, #marketplace_id, #merchant_id, #path
Instance Method Summary collapse
-
#authorize(amazon_order_reference_id, authorization_reference_id, authorization_amount, opts = {}) ⇒ Peddler::XMLParser
Reserves a specified amount against the payment method(s) stored in the order reference.
-
#authorize_on_billing_agreement(amazon_billing_agreement_id, authorization_reference_id, authorization_amount, opts = {}) ⇒ Peddler::XMLParser
Reserves a specified amount against the payment method(s) stored in the billing agreement.
-
#cancel_order_reference(amazon_order_reference_id, opts = {}) ⇒ Peddler::XMLParser
Cancels a previously confirmed order reference.
-
#capture(amazon_authorization_id, capture_reference_id, capture_amount, opts = {}) ⇒ Peddler::XMLParser
Captures funds from an authorized payment instrument.
-
#close_authorization(amazon_authorization_id, opts = {}) ⇒ Peddler::XMLParser
Closes an authorization.
-
#close_billing_agreement(amazon_billing_agreement_id, opts = {}) ⇒ Peddler::XMLParser
Confirms that you want to terminate the billing agreement with the buyer and that you do not expect to create any new order references or authorizations on this billing agreement.
-
#close_order_reference(amazon_order_reference_id, opts = {}) ⇒ Peddler::XMLParser
Confirms that an order reference has been fulfilled (fully or partially) and that you do not expect to create any new authorizations on this order reference.
-
#confirm_billing_agreement(amazon_billing_agreement_id) ⇒ Peddler::XMLParser
Confirms that the billing agreement is free of constraints and all required information has been set on the billing agreement.
-
#confirm_order_reference(amazon_order_reference_id) ⇒ Peddler::XMLParser
Confirms that the order reference is free of constraints and all required information has been set on the order reference.
-
#create_order_reference_for_id(id, id_type, opts = {}) ⇒ Peddler::XMLParser
Creates an order reference for the given object.
-
#get_authorization_details(amazon_authorization_id) ⇒ Peddler::XMLParser
Returns the status of a particular authorization and the total amount captured on the authorization.
-
#get_billing_agreement_details(amazon_billing_agreement_id, opts = {}) ⇒ Peddler::XMLParser
Returns details about the Billing Agreement object and its current state.
-
#get_capture_details(amazon_capture_id) ⇒ Peddler::XMLParser
Returns the status of a particular capture and the total amount refunded on the capture.
-
#get_order_reference_details(amazon_order_reference_id, opts = {}) ⇒ Peddler::XMLParser
Returns details about the Order Reference object and its current state.
-
#get_refund_details(amazon_refund_id) ⇒ Peddler::XMLParser
Returns the status of a particular refund.
-
#get_service_status ⇒ Peddler::XMLParser
Gets the operational status of the API.
-
#refund(amazon_capture_id, refund_reference_id, refund_amount, opts = {}) ⇒ Peddler::XMLParser
Refunds a previously captured amount.
-
#sandbox ⇒ self
Switches the client to the sandbox environment.
-
#set_billing_agreement_details(amazon_billing_agreement_id, billing_agreement_attributes) ⇒ Peddler::XMLParser
Sets billing agreement details such as a description of the agreement and other information about the seller.
-
#set_order_reference_details(amazon_order_reference_id, order_total, opts = {}) ⇒ Peddler::XMLParser
Sets order reference details such as the order total and a description for the order.
-
#validate_billing_agreement(amazon_billing_agreement_id) ⇒ Peddler::XMLParser
Validates the status of the BillingAgreement object and the payment method associated with it.
Methods inherited from Peddler::Client
#aws_endpoint, #defaults, #headers, inherited, #initialize, #marketplace, #on_error, #operation, parser, parser=, path, #run
Constructor Details
This class inherits a constructor from Peddler::Client
Instance Method Details
#authorize(amazon_order_reference_id, authorization_reference_id, authorization_amount, opts = {}) ⇒ Peddler::XMLParser
Reserves a specified amount against the payment method(s) stored in the order reference
247 248 249 250 251 252 253 254 255 256 |
# File 'lib/mws/off_amazon_payments/client.rb', line 247 def (amazon_order_reference_id, , , opts = {}) operation('Authorize') .add(opts.update( 'AmazonOrderReferenceId' => amazon_order_reference_id, 'AuthorizationReferenceId' => , 'AuthorizationAmount' => )) run end |
#authorize_on_billing_agreement(amazon_billing_agreement_id, authorization_reference_id, authorization_amount, opts = {}) ⇒ Peddler::XMLParser
Reserves a specified amount against the payment method(s) stored in the billing agreement
127 128 129 130 131 132 133 134 135 136 |
# File 'lib/mws/off_amazon_payments/client.rb', line 127 def (amazon_billing_agreement_id, , , opts = {}) operation('AuthorizeOnBillingAgreement') .add(opts.update( 'AmazonBillingAgreementId' => amazon_billing_agreement_id, 'AuthorizationReferenceId' => , 'AuthorizationAmount' => )) run end |
#cancel_order_reference(amazon_order_reference_id, opts = {}) ⇒ Peddler::XMLParser
Cancels a previously confirmed order reference
211 212 213 214 215 216 |
# File 'lib/mws/off_amazon_payments/client.rb', line 211 def cancel_order_reference(amazon_order_reference_id, opts = {}) operation('CancelOrderReference') .add(opts.update('AmazonOrderReferenceId' => amazon_order_reference_id)) run end |
#capture(amazon_authorization_id, capture_reference_id, capture_amount, opts = {}) ⇒ Peddler::XMLParser
Captures funds from an authorized payment instrument
281 282 283 284 285 286 287 288 289 290 |
# File 'lib/mws/off_amazon_payments/client.rb', line 281 def capture(, capture_reference_id, capture_amount, opts = {}) operation('Capture') .add(opts.update( 'AmazonAuthorizationId' => , 'CaptureReferenceId' => capture_reference_id, 'CaptureAmount' => capture_amount )) run end |
#close_authorization(amazon_authorization_id, opts = {}) ⇒ Peddler::XMLParser
Closes an authorization
312 313 314 315 316 317 |
# File 'lib/mws/off_amazon_payments/client.rb', line 312 def (, opts = {}) operation('CloseAuthorization') .add(opts.update('AmazonAuthorizationId' => )) run end |
#close_billing_agreement(amazon_billing_agreement_id, opts = {}) ⇒ Peddler::XMLParser
Confirms that you want to terminate the billing agreement with the buyer and that you do not expect to create any new order references or authorizations on this billing agreement
147 148 149 150 151 152 153 154 |
# File 'lib/mws/off_amazon_payments/client.rb', line 147 def close_billing_agreement(amazon_billing_agreement_id, opts = {}) operation('CloseBillingAgreement') .add(opts.update( 'AmazonBillingAgreementId' => amazon_billing_agreement_id )) run end |
#close_order_reference(amazon_order_reference_id, opts = {}) ⇒ Peddler::XMLParser
Confirms that an order reference has been fulfilled (fully or partially) and that you do not expect to create any new authorizations on this order reference
227 228 229 230 231 232 |
# File 'lib/mws/off_amazon_payments/client.rb', line 227 def close_order_reference(amazon_order_reference_id, opts = {}) operation('CloseOrderReference') .add(opts.update('AmazonOrderReferenceId' => amazon_order_reference_id)) run end |
#confirm_billing_agreement(amazon_billing_agreement_id) ⇒ Peddler::XMLParser
Confirms that the billing agreement is free of constraints and all required information has been set on the billing agreement
86 87 88 89 90 91 92 93 |
# File 'lib/mws/off_amazon_payments/client.rb', line 86 def confirm_billing_agreement(amazon_billing_agreement_id) operation('ConfirmBillingAgreement') .add( 'AmazonBillingAgreementId' => amazon_billing_agreement_id ) run end |
#confirm_order_reference(amazon_order_reference_id) ⇒ Peddler::XMLParser
Confirms that the order reference is free of constraints and all required information has been set on the order reference
197 198 199 200 201 202 |
# File 'lib/mws/off_amazon_payments/client.rb', line 197 def confirm_order_reference(amazon_order_reference_id) operation('ConfirmOrderReference') .add('AmazonOrderReferenceId' => amazon_order_reference_id) run end |
#create_order_reference_for_id(id, id_type, opts = {}) ⇒ Peddler::XMLParser
Creates an order reference for the given object
37 38 39 40 41 42 43 44 45 |
# File 'lib/mws/off_amazon_payments/client.rb', line 37 def create_order_reference_for_id(id, id_type, opts = {}) operation('CreateOrderReferenceForId') .add(opts.update( 'Id' => id, 'IdType' => id_type )) run end |
#get_authorization_details(amazon_authorization_id) ⇒ Peddler::XMLParser
Returns the status of a particular authorization and the total amount captured on the authorization
264 265 266 267 268 269 |
# File 'lib/mws/off_amazon_payments/client.rb', line 264 def () operation('GetAuthorizationDetails') .add('AmazonAuthorizationId' => ) run end |
#get_billing_agreement_details(amazon_billing_agreement_id, opts = {}) ⇒ Peddler::XMLParser
Returns details about the Billing Agreement object and its current state
54 55 56 57 58 59 60 61 |
# File 'lib/mws/off_amazon_payments/client.rb', line 54 def get_billing_agreement_details(amazon_billing_agreement_id, opts = {}) operation('GetBillingAgreementDetails') .add(opts.update( 'AmazonBillingAgreementId' => amazon_billing_agreement_id )) run end |
#get_capture_details(amazon_capture_id) ⇒ Peddler::XMLParser
Returns the status of a particular capture and the total amount refunded on the capture
298 299 300 301 302 303 |
# File 'lib/mws/off_amazon_payments/client.rb', line 298 def get_capture_details(amazon_capture_id) operation('GetCaptureDetails') .add('AmazonCaptureId' => amazon_capture_id) run end |
#get_order_reference_details(amazon_order_reference_id, opts = {}) ⇒ Peddler::XMLParser
Returns details about the Order Reference object and its current state
184 185 186 187 188 189 |
# File 'lib/mws/off_amazon_payments/client.rb', line 184 def get_order_reference_details(amazon_order_reference_id, opts = {}) operation('GetOrderReferenceDetails') .add(opts.update('AmazonOrderReferenceId' => amazon_order_reference_id)) run end |
#get_refund_details(amazon_refund_id) ⇒ Peddler::XMLParser
Returns the status of a particular refund
345 346 347 348 349 350 |
# File 'lib/mws/off_amazon_payments/client.rb', line 345 def get_refund_details(amazon_refund_id) operation('GetRefundDetails') .add('AmazonRefundId' => amazon_refund_id) run end |
#get_service_status ⇒ Peddler::XMLParser
Gets the operational status of the API
356 357 358 359 |
# File 'lib/mws/off_amazon_payments/client.rb', line 356 def get_service_status operation('GetServiceStatus') run end |
#refund(amazon_capture_id, refund_reference_id, refund_amount, opts = {}) ⇒ Peddler::XMLParser
Refunds a previously captured amount
329 330 331 332 333 334 335 336 337 338 |
# File 'lib/mws/off_amazon_payments/client.rb', line 329 def refund(amazon_capture_id, refund_reference_id, refund_amount, opts = {}) operation('Refund') .add(opts.update( 'AmazonCaptureId' => amazon_capture_id, 'RefundReferenceId' => refund_reference_id, 'RefundAmount' => refund_amount )) run end |
#sandbox ⇒ self
Switches the client to the sandbox environment
23 24 25 26 |
# File 'lib/mws/off_amazon_payments/client.rb', line 23 def sandbox self.path = '/OffAmazonPayments_Sandbox/2013-01-01/' self end |
#set_billing_agreement_details(amazon_billing_agreement_id, billing_agreement_attributes) ⇒ Peddler::XMLParser
Sets billing agreement details such as a description of the agreement and other information about the seller
70 71 72 73 74 75 76 77 78 |
# File 'lib/mws/off_amazon_payments/client.rb', line 70 def set_billing_agreement_details(amazon_billing_agreement_id, billing_agreement_attributes) operation('SetBillingAgreementDetails') .add( 'AmazonBillingAgreementId' => amazon_billing_agreement_id, 'BillingAgreementAttributes' => billing_agreement_attributes ) run end |
#set_order_reference_details(amazon_order_reference_id, order_total, opts = {}) ⇒ Peddler::XMLParser
Sets order reference details such as the order total and a description for the order
167 168 169 170 171 172 173 174 175 |
# File 'lib/mws/off_amazon_payments/client.rb', line 167 def set_order_reference_details(amazon_order_reference_id, order_total, opts = {}) operation('SetOrderReferenceDetails') .add( 'AmazonOrderReferenceId' => amazon_order_reference_id, 'OrderReferenceAttributes' => opts.update('OrderTotal' => order_total) ) run end |
#validate_billing_agreement(amazon_billing_agreement_id) ⇒ Peddler::XMLParser
Validates the status of the BillingAgreement object and the payment method associated with it
101 102 103 104 105 106 107 108 |
# File 'lib/mws/off_amazon_payments/client.rb', line 101 def validate_billing_agreement(amazon_billing_agreement_id) operation('ValidateBillingAgreement') .add( 'AmazonBillingAgreementId' => amazon_billing_agreement_id ) run end |