Class: AmazonPay::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/amazon_pay/client.rb,
lib/amazon_pay/client_helper.rb

Overview

This will extend the client class to add additional helper methods that combine core API calls.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(merchant_id, access_key, secret_key, sandbox: false, currency_code: :usd, region: :na, platform_id: nil, throttle: true, application_name: nil, application_version: nil, proxy_addr: :ENV, proxy_port: nil, proxy_user: nil, proxy_pass: nil, log_enabled: false, log_file_name: nil, log_level: :DEBUG) ⇒ Client

API keys are located at:

Parameters:

  • merchant_id (String)
  • access_key (String)
  • secret_key (String)

See Also:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/amazon_pay/client.rb', line 55

def initialize(
  merchant_id,
  access_key,
  secret_key,
  sandbox: false,
  currency_code: :usd,
  region: :na,
  platform_id: nil,
  throttle: true,
  application_name: nil,
  application_version: nil,
  proxy_addr: :ENV,
  proxy_port: nil,
  proxy_user: nil,
  proxy_pass: nil,
  log_enabled: false,
  log_file_name: nil,
  log_level: :DEBUG
)
  @merchant_id = merchant_id
  @access_key = access_key
  @secret_key = secret_key
  @currency_code = currency_code.to_s.upcase
  @sandbox = sandbox
  @sandbox_str = @sandbox ? 'OffAmazonPayments_Sandbox' : 'OffAmazonPayments'
  @region = region
  @mws_endpoint = region_hash[@region] ? region_hash[@region] : raise("Invalid Region Code. (#{@region})")
  @platform_id = platform_id
  @throttle = throttle
  @application_name = application_name
  @application_version = application_version
  @proxy_addr = proxy_addr
  @proxy_port = proxy_port
  @proxy_user = proxy_user
  @proxy_pass = proxy_pass

  @default_hash = {
    'AWSAccessKeyId' => @access_key,
    'SignatureMethod' => 'HmacSHA256',
    'SignatureVersion' => '2',
    'Version' => AmazonPay::API_VERSION
  }

  @log_enabled = log_enabled
  @log_level = log_level
  @log_file_name = log_file_name

  @default_hash['PlatformId'] = @platform_id if @platform_id
end

Instance Attribute Details

#access_key ⇒ Object (readonly)

Returns the value of attribute access_key.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def access_key
  @access_key
end

#application_name ⇒ Object (readonly)

Returns the value of attribute application_name.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def application_name
  @application_name
end

#application_version ⇒ Object (readonly)

Returns the value of attribute application_version.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def application_version
  @application_version
end

#currency_code ⇒ Object (readonly)

Returns the value of attribute currency_code.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def currency_code
  @currency_code
end

#log_enabled ⇒ Object (readonly)

Returns the value of attribute log_enabled.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def log_enabled
  @log_enabled
end

#log_file_name ⇒ Object (readonly)

Returns the value of attribute log_file_name.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def log_file_name
  @log_file_name
end

#log_level ⇒ Object (readonly)

Returns the value of attribute log_level.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def log_level
  @log_level
end

#merchant_id ⇒ Object (readonly)

Returns the value of attribute merchant_id.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def merchant_id
  @merchant_id
end

#platform_id ⇒ Object (readonly)

Returns the value of attribute platform_id.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def platform_id
  @platform_id
end

#proxy_addr ⇒ Object

Returns the value of attribute proxy_addr.



28
29
30
 
# File 'lib/amazon_pay/client.rb', line 28

def proxy_addr
  @proxy_addr
end

#proxy_pass ⇒ Object

Returns the value of attribute proxy_pass.



28
29
30
 
# File 'lib/amazon_pay/client.rb', line 28

def proxy_pass
  @proxy_pass
end

#proxy_port ⇒ Object

Returns the value of attribute proxy_port.



28
29
30
 
# File 'lib/amazon_pay/client.rb', line 28

def proxy_port
  @proxy_port
end

#proxy_user ⇒ Object

Returns the value of attribute proxy_user.



28
29
30
 
# File 'lib/amazon_pay/client.rb', line 28

def proxy_user
  @proxy_user
end

#region ⇒ Object (readonly)

Returns the value of attribute region.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def region
  @region
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def sandbox
  @sandbox
end

#secret_key ⇒ Object (readonly)

Returns the value of attribute secret_key.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def secret_key
  @secret_key
end

#throttle ⇒ Object (readonly)

Returns the value of attribute throttle.



12
13
14
 
# File 'lib/amazon_pay/client.rb', line 12

def throttle
  @throttle
end

Instance Method Details

#authorize(amazon_order_reference_id, authorization_reference_id, amount, currency_code: @currency_code, seller_authorization_note: nil, transaction_timeout: nil, capture_now: nil, soft_descriptor: nil, provider_credit_details: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Reserves a specified amount against the payment method(s) stored in the order reference

Parameters:

  • amazon_order_reference_id (String)
  • authorization_reference_id (String)
  • amount (String)

See Also:



683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/amazon_pay/client.rb', line 683

def authorize(
  amazon_order_reference_id,
  authorization_reference_id,
  amount,
  currency_code: @currency_code,
  seller_authorization_note: nil,
  transaction_timeout: nil,
  capture_now: nil,
  soft_descriptor: nil,
  provider_credit_details: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'Authorize',
    'SellerId' => merchant_id,
    'AmazonOrderReferenceId' => amazon_order_reference_id,
    'AuthorizationReferenceId' => authorization_reference_id,
    'AuthorizationAmount.Amount' => amount,
    'AuthorizationAmount.CurrencyCode' => currency_code
  }

  optional = {
    'SellerAuthorizationNote' => seller_authorization_note,
    'TransactionTimeout' => transaction_timeout,
    'CaptureNow' => capture_now,
    'SoftDescriptor' => soft_descriptor,
    'MWSAuthToken' => mws_auth_token
  }

  optional.merge!(set_provider_credit_details(provider_credit_details)) if provider_credit_details

  operation(parameters, optional)
end

#authorize_on_billing_agreement(amazon_billing_agreement_id, authorization_reference_id, amount, currency_code: @currency_code, seller_authorization_note: nil, transaction_timeout: nil, capture_now: false, soft_descriptor: nil, seller_note: nil, platform_id: nil, custom_information: nil, seller_order_id: nil, store_name: nil, inherit_shipping_address: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Reserves a specified amount against the payment method(s) stored in the billing agreement

Parameters:

  • amazon_billing_agreement_id (String)
  • authorization_reference_id (String)
  • amount (String)

See Also:



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/amazon_pay/client.rb', line 306

def authorize_on_billing_agreement(
  amazon_billing_agreement_id,
  authorization_reference_id,
  amount,
  currency_code: @currency_code,
  seller_authorization_note: nil,
  transaction_timeout: nil,
  capture_now: false,
  soft_descriptor: nil,
  seller_note: nil,
  platform_id: nil,
  custom_information: nil,
  seller_order_id: nil,
  store_name: nil,
  inherit_shipping_address: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'AuthorizeOnBillingAgreement',
    'SellerId' => merchant_id,
    'AmazonBillingAgreementId' => amazon_billing_agreement_id,
    'AuthorizationReferenceId' => authorization_reference_id,
    'AuthorizationAmount.Amount' => amount,
    'AuthorizationAmount.CurrencyCode' => currency_code
  }

  optional = {
    'SellerAuthorizationNote' => seller_authorization_note,
    'TransactionTimeout' => transaction_timeout,
    'CaptureNow' => capture_now,
    'SoftDescriptor' => soft_descriptor,
    'SellerNote' => seller_note,
    'PlatformId' => platform_id,
    'SellerOrderAttributes.CustomInformation' => custom_information,
    'SellerOrderAttributes.SellerOrderId' => seller_order_id,
    'SellerOrderAttributes.StoreName' => store_name,
    'InheritShippingAddress' => inherit_shipping_address,
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#cancel_order_reference(amazon_order_reference_id, cancelation_reason: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Cancels a previously confirmed order reference

Parameters:

  • amazon_order_reference_id (String)

See Also:



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/amazon_pay/client.rb', line 648

def cancel_order_reference(
  amazon_order_reference_id,
  cancelation_reason: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'CancelOrderReference',
    'SellerId' => merchant_id,
    'AmazonOrderReferenceId' => amazon_order_reference_id
  }

  optional = {
    'CancelationReason' => cancelation_reason,
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#capture(amazon_authorization_id, capture_reference_id, amount, currency_code: @currency_code, seller_capture_note: nil, soft_descriptor: nil, provider_credit_details: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Captures funds from an authorized payment instrument.

Parameters:

  • amazon_authorization_id (String)
  • capture_reference_id (String)
  • amount (String)

See Also:



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/amazon_pay/client.rb', line 755

def capture(
  amazon_authorization_id,
  capture_reference_id,
  amount,
  currency_code: @currency_code,
  seller_capture_note: nil,
  soft_descriptor: nil,
  provider_credit_details: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'Capture',
    'SellerId' => merchant_id,
    'AmazonAuthorizationId' => amazon_authorization_id,
    'CaptureReferenceId' => capture_reference_id,
    'CaptureAmount.Amount' => amount,
    'CaptureAmount.CurrencyCode' => currency_code
  }

  optional = {
    'SellerCaptureNote' => seller_capture_note,
    'SoftDescriptor' => soft_descriptor,
    'MWSAuthToken' => mws_auth_token
  }

  optional.merge!(set_provider_credit_details(provider_credit_details)) if provider_credit_details

  operation(parameters, optional)
end

#charge(amazon_reference_id, authorization_reference_id, charge_amount, charge_currency_code: @currency_code, charge_note: nil, charge_order_id: nil, store_name: nil, custom_information: nil, soft_descriptor: nil, platform_id: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

This method combines multiple API calls to perform a complete transaction with minimum requirements.

Parameters:

  • amazon_reference_id (String)
  • authorization_reference_id (String)
  • charge_amount (String) 


19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/amazon_pay/client_helper.rb', line 19

def charge(
  amazon_reference_id,
  authorization_reference_id,
  charge_amount,
  charge_currency_code: @currency_code,
  charge_note: nil,
  charge_order_id: nil,
  store_name: nil,
  custom_information: nil,
  soft_descriptor: nil,
  platform_id: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  if is_order_reference?(amazon_reference_id)
    response = call_order_reference_api(
      amazon_reference_id,
      authorization_reference_id,
      charge_amount,
      charge_currency_code,
      charge_note,
      charge_order_id,
      store_name,
      custom_information,
      soft_descriptor,
      platform_id,
      merchant_id,
      mws_auth_token
    )
    return response
  end

  if is_billing_agreement?(amazon_reference_id)
    response = call_billing_agreement_api(
      amazon_reference_id,
      authorization_reference_id,
      charge_amount,
      charge_currency_code,
      charge_note,
      charge_order_id,
      store_name,
      custom_information,
      soft_descriptor,
      platform_id,
      merchant_id,
      mws_auth_token
    )
    return response
  end
end

#close_authorization(amazon_authorization_id, closure_reason: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Closes an authorization

Parameters:

  • amazon_authorization_id (String)

See Also:



885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/amazon_pay/client.rb', line 885

def close_authorization(
  amazon_authorization_id,
  closure_reason: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'CloseAuthorization',
    'SellerId' => merchant_id,
    'AmazonAuthorizationId' => amazon_authorization_id
  }

  optional = {
    'ClosureReason' => closure_reason,
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#close_billing_agreement(amazon_billing_agreement_id, closure_reason: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

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

Parameters:

  • amazon_billing_agreement_id (String)

See Also:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/amazon_pay/client.rb', line 359

def close_billing_agreement(
  amazon_billing_agreement_id,
  closure_reason: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'CloseBillingAgreement',
    'SellerId' => merchant_id,
    'AmazonBillingAgreementId' => amazon_billing_agreement_id
  }

  optional = {
    'ClosureReason' => closure_reason,
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#close_order_reference(amazon_order_reference_id, closure_reason: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

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

Parameters:

  • amazon_order_reference_id (String)

See Also:



914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'lib/amazon_pay/client.rb', line 914

def close_order_reference(
  amazon_order_reference_id,
  closure_reason: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'CloseOrderReference',
    'SellerId' => merchant_id,
    'AmazonOrderReferenceId' => amazon_order_reference_id
  }

  optional = {
    'ClosureReason' => closure_reason,
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#confirm_billing_agreement(amazon_billing_agreement_id, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Confirms that the billing agreement is free of constraints and all required information has been set on the billing agreement

Parameters:

  • amazon_billing_agreement_id (String)

See Also:



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/amazon_pay/client.rb', line 243

def confirm_billing_agreement(
  amazon_billing_agreement_id,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'ConfirmBillingAgreement',
    'SellerId' => merchant_id,
    'AmazonBillingAgreementId' => amazon_billing_agreement_id
  }

  optional = {
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#confirm_order_reference(amazon_order_reference_id, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Confirms that the order reference is free of constraints and all required information has been set on the order reference

Parameters:

  • amazon_order_reference_id (String)

See Also:



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/amazon_pay/client.rb', line 623

def confirm_order_reference(
  amazon_order_reference_id,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'ConfirmOrderReference',
    'SellerId' => merchant_id,
    'AmazonOrderReferenceId' => amazon_order_reference_id
  }

  optional = {
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#create_order_reference_for_id(id, id_type, inherit_shipping_address: nil, confirm_now: nil, amount: nil, currency_code: @currency_code, platform_id: nil, seller_note: nil, seller_order_id: nil, store_name: nil, custom_information: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Creates an order reference for the given object

Parameters:

  • id (String)
  • id_type (String)

See Also:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/amazon_pay/client.rb', line 131

def create_order_reference_for_id(
  id,
  id_type,
  inherit_shipping_address: nil,
  confirm_now: nil,
  amount: nil,
  currency_code: @currency_code,
  platform_id: nil,
  seller_note: nil,
  seller_order_id: nil,
  store_name: nil,
  custom_information: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'CreateOrderReferenceForId',
    'SellerId' => merchant_id,
    'Id' => id,
    'IdType' => id_type
  }

  optional = {
    'InheritShippingAddress' => inherit_shipping_address,
    'ConfirmNow' => confirm_now,
    'OrderReferenceAttributes.OrderTotal.Amount' => amount,
    'OrderReferenceAttributes.OrderTotal.CurrencyCode' => currency_code,
    'OrderReferenceAttributes.PlatformId' => platform_id,
    'OrderReferenceAttributes.SellerNote' => seller_note,
    'OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId' => seller_order_id,
    'OrderReferenceAttributes.SellerOrderAttributes.StoreName' => store_name,
    'OrderReferenceAttributes.SellerOrderAttributes.CustomInformation' => custom_information,
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#get_authorization_details(amazon_authorization_id, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Returns the status of a particular authorization and the total amount captured on the authorization

Parameters:

  • amazon_authorization_id (String)

See Also:



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/amazon_pay/client.rb', line 725

def get_authorization_details(
  amazon_authorization_id,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'GetAuthorizationDetails',
    'SellerId' => merchant_id,
    'AmazonAuthorizationId' => amazon_authorization_id
  }

  optional = {
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#get_billing_agreement_details(amazon_billing_agreement_id, address_consent_token: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Returns details about the Billing Agreement object and its current state

Parameters:

  • amazon_billing_agreement_id (String)

See Also:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/amazon_pay/client.rb', line 176

def get_billing_agreement_details(
  amazon_billing_agreement_id,
  address_consent_token: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'GetBillingAgreementDetails',
    'SellerId' => merchant_id,
    'AmazonBillingAgreementId' => amazon_billing_agreement_id
  }

  optional = {
    'AddressConsentToken' => address_consent_token,
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#get_capture_details(amazon_capture_id, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Returns the status of a particular capture and the total amount refunded on the capture

Parameters:

  • amazon_capture_id (String)

See Also:



793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/amazon_pay/client.rb', line 793

def get_capture_details(
  amazon_capture_id,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'GetCaptureDetails',
    'SellerId' => merchant_id,
    'AmazonCaptureId' => amazon_capture_id
  }

  optional = {
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#get_merchant_account_status(merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Returns status of the merchant



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/amazon_pay/client.rb', line 449

def (
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'GetMerchantAccountStatus',
    'SellerId' => merchant_id
  }

  optional = {
    'MWSAuthToken' => mws_auth_token
  }
  
  operation(parameters, optional)
end

#get_order_reference_details(amazon_order_reference_id, address_consent_token: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Returns details about the Order Reference object and its current state

Parameters:

  • amazon_order_reference_id (String)

See Also:



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/amazon_pay/client.rb', line 472

def get_order_reference_details(
  amazon_order_reference_id,
  address_consent_token: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'GetOrderReferenceDetails',
    'SellerId' => merchant_id,
    'AmazonOrderReferenceId' => amazon_order_reference_id
  }

  optional = {
    'AddressConsentToken' => address_consent_token,
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#get_provider_credit_details(amazon_provider_credit_id, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Parameters:

  • amazon_provider_credit_id (String) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
 
# File 'lib/amazon_pay/client.rb', line 938

def get_provider_credit_details(
  amazon_provider_credit_id,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'GetProviderCreditDetails',
    'SellerId' => merchant_id,
    'AmazonProviderCreditId' => amazon_provider_credit_id
  }

  optional = {
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#get_provider_credit_reversal_details(amazon_provider_credit_reversal_id, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Parameters:

  • amazon_provider_credit_reversal_id (String) 


960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/amazon_pay/client.rb', line 960

def get_provider_credit_reversal_details(
  amazon_provider_credit_reversal_id,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'GetProviderCreditReversalDetails',
    'SellerId' => merchant_id,
    'AmazonProviderCreditReversalId' => amazon_provider_credit_reversal_id
  }

  optional = {
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#get_refund_details(amazon_refund_id, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Returns the status of a particular refund

Parameters:

  • amazon_refund_id (String)

See Also:



860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
 
# File 'lib/amazon_pay/client.rb', line 860

def get_refund_details(
  amazon_refund_id,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'GetRefundDetails',
    'SellerId' => merchant_id,
    'AmazonRefundId' => amazon_refund_id
  }

  optional = {
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#get_service_status ⇒ Object

The GetServiceStatus operation returns the operational status of the AmazonPay API section of Amazon Marketplace Web Service (Amazon MWS). Status values are GREEN, GREEN_I, YELLOW, and RED.

See Also:



108
109
110
111
112
113
114
 
# File 'lib/amazon_pay/client.rb', line 108

def get_service_status
  parameters = {
    'Action' => 'GetServiceStatus'
  }

  operation(parameters, {})
end

#list_order_reference(query_id, query_id_type, created_time_range_start: nil, created_time_range_end: nil, sort_order: nil, page_size: nil, order_reference_status_list_filter: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Allows the search of any Amazon Pay order made using secondary seller order IDs generated manually, a solution provider, or a custom order fulfillment service.

Parameters:

  • query_id (String)
  • query_id_type (String) 


392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/amazon_pay/client.rb', line 392

def list_order_reference(
  query_id,
  query_id_type,
  created_time_range_start: nil,
  created_time_range_end: nil,
  sort_order: nil,
  page_size: nil,
  order_reference_status_list_filter: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  payment_domain = payment_domain_hash[@region]

  parameters = {
    'Action' => 'ListOrderReference',
    'SellerId' => merchant_id,
    'QueryId' => query_id,
    'QueryIdType' => query_id_type
  }

  optional = {
    'CreatedTimeRange.StartTime' => created_time_range_start,
    'CreatedTimeRange.EndTime' => created_time_range_end,
    'SortOrder' => sort_order,
    'PageSize' => page_size,
    'PaymentDomain' => payment_domain,
    'MWSAuthToken' => mws_auth_token
  }

  if order_reference_status_list_filter
    order_reference_status_list_filter.each_with_index do |val, index|
      optional_key = "OrderReferenceStatusListFilter.OrderReferenceStatus.#{index + 1}"
      optional[optional_key] = val
    end
  end

  operation(parameters, optional)
end

#list_order_reference_by_next_token(next_page_token) ⇒ Object

When ListOrderReference returns multiple pages you can continue by using the NextPageToken returned by ListOrderReference

Parameters:

  • next_page_token (String) 


436
437
438
439
440
441
442
443
444
 
# File 'lib/amazon_pay/client.rb', line 436

def list_order_reference_by_next_token(next_page_token)
  parameters = {
    'Action' => 'ListOrderReferenceByNextToken',
    'SellerId' => @merchant_id,
    'NextPageToken' => next_page_token
  }

  operation(parameters, {})
end

#modify_order_attributes(amazon_order_reference_id, seller_note: nil, seller_order_id: nil, payment_service_provider_id: nil, payment_service_provider_order_id: nil, request_payment_authorization: nil, store_name: nil, custom_information: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Modify order attributes such as CustomInformation for the order This is a convenience function for set_order_attributes to prevent accidentally passing extra variables that can’t be modified ater Amazon Order Reference (ORO) is confirmed.

Parameters:

  • amazon_order_reference_id (String)

See Also:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/amazon_pay/client_helper.rb', line 84

def modify_order_attributes(
  amazon_order_reference_id,
  seller_note: nil,
  seller_order_id: nil,
  payment_service_provider_id: nil,
  payment_service_provider_order_id: nil,
  request_payment_authorization: nil,
  store_name: nil,
  custom_information: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  set_order_attributes(amazon_order_reference_id,
    # amount:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
    # currency_code:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
    # platform_id:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
    seller_note: seller_note,
    seller_order_id: seller_order_id,
    payment_service_provider_id: payment_service_provider_id,
    payment_service_provider_order_id: payment_service_provider_order_id,
    request_payment_authorization: request_payment_authorization,
    store_name: store_name,
    # order_item_categories:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
    custom_information: custom_information,
    merchant_id: merchant_id,
    mws_auth_token: mws_auth_token
  )
end

#refund(amazon_capture_id, refund_reference_id, amount, currency_code: @currency_code, seller_refund_note: nil, soft_descriptor: nil, provider_credit_reversal_details: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Refunds a previously captured amount

Parameters:

  • amazon_capture_id (String)
  • refund_reference_id (String)
  • amount (String)

See Also:



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/amazon_pay/client.rb', line 823

def refund(
  amazon_capture_id,
  refund_reference_id,
  amount,
  currency_code: @currency_code,
  seller_refund_note: nil,
  soft_descriptor: nil,
  provider_credit_reversal_details: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'Refund',
    'SellerId' => merchant_id,
    'AmazonCaptureId' => amazon_capture_id,
    'RefundReferenceId' => refund_reference_id,
    'RefundAmount.Amount' => amount,
    'RefundAmount.CurrencyCode' => currency_code
  }

  optional = {
    'SellerRefundNote' => seller_refund_note,
    'SoftDescriptor' => soft_descriptor,
    'MWSAuthToken' => mws_auth_token
  }

  optional.merge!(set_provider_credit_reversal_details(provider_credit_reversal_details)) if provider_credit_reversal_details

  operation(parameters, optional)
end

#reverse_provider_credit(amazon_provider_credit_id, credit_reversal_reference_id, amount, currency_code: @currency_code, credit_reversal_note: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Parameters:

  • amazon_provider_credit_id (String)
  • credit_reversal_reference_id (String)
  • amount (String) 


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'lib/amazon_pay/client.rb', line 986

def reverse_provider_credit(
  amazon_provider_credit_id,
  credit_reversal_reference_id,
  amount,
  currency_code: @currency_code,
  credit_reversal_note: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'ReverseProviderCredit',
    'SellerId' => merchant_id,
    'AmazonProviderCreditId' => amazon_provider_credit_id,
    'CreditReversalReferenceId' => credit_reversal_reference_id,
    'CreditReversalAmount.Amount' => amount,
    'CreditReversalAmount.CurrencyCode' => currency_code
  }

  optional = {
    'CreditReversalNote' => credit_reversal_note,
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#set_billing_agreement_details(amazon_billing_agreement_id, platform_id: nil, seller_note: nil, seller_billing_agreement_id: nil, custom_information: nil, store_name: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Sets billing agreement details such as a description of the agreement and other information about the seller.

Parameters:

  • amazon_billing_agreement_id (String)

See Also:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/amazon_pay/client.rb', line 208

def set_billing_agreement_details(
  amazon_billing_agreement_id,
  platform_id: nil,
  seller_note: nil,
  seller_billing_agreement_id: nil,
  custom_information: nil,
  store_name: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'SetBillingAgreementDetails',
    'SellerId' => merchant_id,
    'AmazonBillingAgreementId' => amazon_billing_agreement_id
  }

  optional = {
    'BillingAgreementAttributes.PlatformId' => platform_id,
    'BillingAgreementAttributes.SellerNote' => seller_note,
    'BillingAgreementAttributes.SellerBillingAgreementAttributes.SellerBillingAgreementId' => seller_billing_agreement_id,
    'BillingAgreementAttributes.SellerBillingAgreementAttributes.CustomInformation' => custom_information,
    'BillingAgreementAttributes.SellerBillingAgreementAttributes.StoreName' => store_name,
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end

#set_order_attributes(amazon_order_reference_id, amount: nil, currency_code: nil, platform_id: nil, seller_note: nil, seller_order_id: nil, payment_service_provider_id: nil, payment_service_provider_order_id: nil, request_payment_authorization: nil, store_name: nil, order_item_categories: nil, custom_information: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Sets order attributes such as the order total and a description for the order

Parameters:

  • amazon_order_reference_id (String)

See Also:



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/amazon_pay/client.rb', line 568

def set_order_attributes(
  amazon_order_reference_id,
  amount: nil,
  currency_code: nil,
  platform_id: nil,
  seller_note: nil,
  seller_order_id: nil,
  payment_service_provider_id: nil,
  payment_service_provider_order_id: nil,
  request_payment_authorization: nil,
  store_name: nil,
  order_item_categories: nil,
  custom_information: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'SetOrderAttributes',
    'SellerId' => merchant_id,
    'AmazonOrderReferenceId' => amazon_order_reference_id
  }

  optional = {
    'OrderAttributes.OrderTotal.Amount' => amount,
    'OrderAttributes.OrderTotal.CurrencyCode' => currency_code,
    'OrderAttributes.PlatformId' => platform_id,
    'OrderAttributes.SellerNote' => seller_note,
    'OrderAttributes.SellerOrderAttributes.SellerOrderId' => seller_order_id,
    'OrderAttributes.PaymentServiceProviderAttributes.PaymentServiceProviderId' => payment_service_provider_id,
    'OrderAttributes.PaymentServiceProviderAttributes.PaymentServiceProviderOrderId' => payment_service_provider_order_id,
    'OrderAttributes.RequestPaymentAuthorization' => request_payment_authorization,
    'OrderAttributes.SellerOrderAttributes.StoreName' => store_name,
    'OrderAttributes.SellerOrderAttributes.CustomInformation' => custom_information,
    'MWSAuthToken' => mws_auth_token
  }

  if order_item_categories
    optional.merge!(
      get_categories_list(
        'OrderAttributes',
        order_item_categories
      )
    )
  end

  operation(parameters, optional)
end

#set_order_reference_details(amazon_order_reference_id, amount, currency_code: @currency_code, platform_id: nil, seller_note: nil, seller_order_id: nil, request_payment_authorization: nil, store_name: nil, order_item_categories: nil, custom_information: nil, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Sets order reference details such as the order total and a description for the order

Parameters:

  • amazon_order_reference_id (String)
  • amount (String)

See Also:



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/amazon_pay/client.rb', line 508

def set_order_reference_details(
  amazon_order_reference_id,
  amount,
  currency_code: @currency_code,
  platform_id: nil,
  seller_note: nil,
  seller_order_id: nil,
  request_payment_authorization: nil,
  store_name: nil,
  order_item_categories: nil,
  custom_information: nil,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'SetOrderReferenceDetails',
    'SellerId' => merchant_id,
    'AmazonOrderReferenceId' => amazon_order_reference_id,
    'OrderReferenceAttributes.OrderTotal.Amount' => amount,
    'OrderReferenceAttributes.OrderTotal.CurrencyCode' => currency_code
  }

  optional = {
    'OrderReferenceAttributes.PlatformId' => platform_id,
    'OrderReferenceAttributes.RequestPaymentAuthorization' => request_payment_authorization,
    'OrderReferenceAttributes.SellerNote' => seller_note,
    'OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId' => seller_order_id,
    'OrderReferenceAttributes.SellerOrderAttributes.StoreName' => store_name,
    'OrderReferenceAttributes.SellerOrderAttributes.CustomInformation' => custom_information,
    'MWSAuthToken' => mws_auth_token
  }

  if order_item_categories
    optional.merge!(
      get_categories_list(
        'OrderReferenceAttributes',
        order_item_categories
      )
    )
  end

  operation(parameters, optional)
end

#validate_billing_agreement(amazon_billing_agreement_id, merchant_id: @merchant_id, mws_auth_token: nil) ⇒ Object

Validates the status of the BillingAgreement object and the payment method associated with it

Parameters:

  • amazon_billing_agreement_id (String)

See Also:



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/amazon_pay/client.rb', line 268

def validate_billing_agreement(
  amazon_billing_agreement_id,
  merchant_id: @merchant_id,
  mws_auth_token: nil
)

  parameters = {
    'Action' => 'ValidateBillingAgreement',
    'SellerId' => merchant_id,
    'AmazonBillingAgreementId' => amazon_billing_agreement_id
  }

  optional = {
    'MWSAuthToken' => mws_auth_token
  }

  operation(parameters, optional)
end