amazon-pay-api-sdk-ruby 1.2.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 428da5a80e49d6cf400205eea58757174f259abce2bb6cc7a83aecd0c1554f5f
-  data.tar.gz: b809960b865a226d7796e506d1712759c0db90119cd886942b5aa9d6ed125681
+  metadata.gz: ec55f9f54ca4cd12db49f81319d1315c7f45a6cf523ae924bb2596665395f839
+  data.tar.gz: c3b68bae12b5784f0535fe51f5b8e1d09a31c52eb3e5d8eb5b78b443b534a975
 SHA512:
-  metadata.gz: 70c5fb962cf91183aca482ad024752e41a11e398cc666bc87aae026cfbef0efa813b0e36d3b5352f184638efe633f6811927db2a29607b115e59fb1af05836a4
-  data.tar.gz: 4f62e310db2e153b5c3110a36498e66a81f0f99d9bed70de7c8722feb1c076392b510233df447f37663e23634a5d567b118806beadc01749947de3817efda2df
+  metadata.gz: 46934a830919a7de8bd646a11f34dbd61dd68a808a50816cb4d976c628104cb1c25376480686324d751bc4bd465d65cd3a3b0b888e1db73c9d2df70446ef1a7b
+  data.tar.gz: f8ac26c439661578e5fc8356922d8c30fdc80ec470f9a2bd013d91c2a55ac2f6819db2ace82ed9128e2d9aba92248908eb1e8e7fec1dc15624b53941c083fc11

data/README.md

@@ -5,7 +5,7 @@ This guide provides step-by-step instructions on how to use the Amazon Pay Clien
 
 ### Prerequisites
 
-- Ruby installed on your system.
+- Ruby (version 2.7.0 or later) installed on your system.
 - `amazon-pay-api-sdk-ruby` gem installed or this source code has been imported in your project.
 - Your `publicKeyId` & `privateKey.pem` file available.
 
@@ -22,6 +22,8 @@ gem 'amazon-pay-api-sdk-ruby'
 bundle install
 ```
 
+**Notice:** Those who may upgrade from 1.x.x to 2.0.0 or higher: You must change the require statement from: `require './lib/amazon_pay'` to `require './lib/amazon-pay-api-sdk-ruby'` or `require 'amazon_pay'` to `require 'amazon-pay-api-sdk-ruby'`
+
 ### Configuration
 
 Create a configuration with your Amazon Pay credentials and region:
@@ -47,7 +49,7 @@ client = AmazonPayClient.new(config)
 Define the payload and headers for the `create_merchant_account` API call:
 
 ```ruby
-require './lib/amazon_pay'
+require 'amazon-pay-api-sdk-ruby'
 
 client = AmazonPayClient.new(config)
 
@@ -509,6 +511,32 @@ else
 end
 ```
 
+### Update Charge
+**Please note that is API is supported only for PSPs (Payment Service Provider)**
+
+```ruby
+def payload = {
+    "statusDetails": {
+        "state": "Canceled",
+        "reasonCode": "ExpiredUnused"
+    }
+}
+
+def headers = {
+    "x-amz-pay-Idempotency-Key": SecureRandom.uuid
+}
+
+response = client.update_charge("S03-XXXXXX-XXXXXX-XXXXXX", payload, headers: headers)
+if response.code.to_i == 200
+    puts "Update Charge API Response:"
+    puts response.body
+else
+    puts "Error: Update Charge API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
 ### Capture Charge
 
 ```ruby
@@ -744,4 +772,139 @@ else
     puts "Status: #{response.code}"
     puts response.body
 end
+```
+
+### Create Dispute API
+#### NOTE: This API is intended to be called only by PSPs (Payment Service Providers).
+
+```ruby
+creation_timestamp = Time.now.to_i
+merchant_response_deadline = creation_timestamp + (14 * 24 * 60 * 60) # Adding 14 days
+
+payload = {
+  "chargeId": "S03-XXXXXX-XXXXXX-XXXXXX",
+  "providerMetadata": {
+    "providerDisputeId": "AXXXXXXXXXX"
+  },  
+  "disputeAmount": {
+    "amount": "1",
+    "currencyCode": "JPY"
+  },  
+  "filingReason": Constants::DISPUTE_FILING_REASON[:PRODUCT_NOT_RECEIVED],
+  "creationTimestamp": creation_timestamp,
+  "statusDetails": {
+    "state": "ActionRequired"
+  },  
+  "merchantResponseDeadline": merchant_response_deadline
+}
+
+def headers = {
+    "x-amz-pay-Idempotency-Key": SecureRandom.uuid
+}
+
+response = client.create_dispute(payload, headers: headers)
+if response.code.to_i == 200
+    puts "Create Dispute API Response:"
+    puts response.body
+else
+    puts "Error: Create Dispute API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Dispute API
+```ruby
+response = client.get_dispute('S03-XXXXXX-XXXXXX-XXXXXX')
+if response.code.to_i == 200
+    puts "Get Dispute API Response:"
+    puts response.body
+else
+    puts "Error: Get Dispute API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Update Dispute API 
+
+```ruby
+current_timestamp = Time.now.to_i
+dispute_id = "S03-XXXXXX-XXXXXX-XXXXXX"
+
+payload = {
+    "statusDetails": {
+        "resolution": Constants::DISPUTE_RESOLUTION[:MERCHANT_WON],
+        "state": Constants::DISPUTE_STATE[:RESOLVED],
+        "reasonCode": Constants::DISPUTE_REASON_CODE[:MERCHANT_ACCEPTED_DISPUTE],
+        "reasonDescription": "Merchant accepted the dispute request"
+    },
+    "closureTimestamp": current_timestamp
+}
+
+def headers = {
+    "x-amz-pay-Idempotency-Key": SecureRandom.uuid
+}
+
+response = client.update_dispute(dispute_id, payload, headers: {})
+if response.code.to_i == 200
+    puts "Update Dispute API Response:"
+    puts response.body
+else
+    puts "Error: Update Dispute API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Contest Dispute API 
+
+```ruby
+current_timestamp = Time.now.to_i
+dispute_id = "S03-XXXXXX-XXXXXX-XXXXXX"
+
+payload = {
+    "merchantEvidences": [
+        "evidenceType": "TrackingNumber",
+        "fileId": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxx",
+        "evidenceText": "raw text supporting merchant evidence"
+    ]
+}
+
+def headers = {
+    "x-amz-pay-Idempotency-Key": SecureRandom.uuid
+}
+
+response = client.contest_dispute(dispute_id, payload, headers: {})
+if response.code.to_i == 200
+    puts "Contest Dispute API Response:"
+    puts response.body
+else
+    puts "Error: Contest Dispute API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### File Upload API 
+
+```ruby
+payload = {
+    "type": "jpg",
+    "purpose": "disputeEvidence"
+}
+
+def headers = {
+    "x-amz-pay-Idempotency-Key": SecureRandom.uuid
+}
+
+response = client.upload_file(payload, headers: headers)
+if response.code.to_i == 200
+    puts "Upload File API Response:"
+    puts response.body
+else
+    puts "Error: Upload File API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
 ```

data/lib/{amazon_pay → amazon-pay-api-sdk-ruby}/client.rb

@@ -1,9 +1,10 @@
 require 'net/http'
 require_relative 'client_helper'
 require_relative 'constants'
+require_relative 'payment_service_provider_client'
 
 # AmazonPayClient class provides methods to interact with Amazon Pay API
-class AmazonPayClient
+class AmazonPayClient include PaymentServiceProviderClient
 
   # Initialize the client with configuration settings
   def initialize(config)
@@ -223,6 +224,18 @@ class AmazonPayClient
     api_call("#{Constants::CHARGES_URL}/#{charge_id}", Constants::GET, headers: headers)
   end
 
+  # API to retrieve charge details. 
+  # The updateCharge operation is used to update the charge status of any PSP (Payment Service Provider) processed payment method (PPM) transactions.
+  # Please note that is API is supported only for PSPs (Payment Service Provider)
+  # @see https://developer.amazon.com/docs/amazon-pay-apis/charge.html#update-charge
+  # @param {String} charge_id - The unique ID of the charge to update.
+  # @param {Object} payload - The payload containing statusDetails.
+  # @param {Object} headers - Optional headers for the request, such as x-amz-pay-idempotency-key, authorization tokens or custom headers.
+  # @return [HTTPResponse] The response from the API call, which includes details of the requested charge.
+  def update_charge(charge_id, payload, headers: {})
+    api_call("#{Constants::CHARGES_URL}/#{charge_id}", Constants::PATCH, payload: payload, headers: headers)
+  end
+
   # API to capture a charge
   # Captures an authorized charge to collect the funds.
   # @see https://developer.amazon.com/docs/amazon-pay-api-v2/charge.html#capture-charge

data/lib/amazon-pay-api-sdk-ruby/constants.rb

@@ -0,0 +1,101 @@
+require 'net/http'
+
+module Constants
+    SDK_TYPE = "amazon-pay-api-sdk-ruby".freeze
+    SDK_VERSION = "2.1.0".freeze
+    API_VERSION = "v2".freeze
+    API_ENDPOINTS = {
+      'na' => 'pay-api.amazon.com',
+      'eu' => 'pay-api.amazon.eu',
+      'jp' => 'pay-api.amazon.jp'
+    }.freeze
+    METHOD_TYPES = {
+      'GET' => Net::HTTP::Get,
+      'POST' => Net::HTTP::Post,
+      'PUT' => Net::HTTP::Put,
+      'PATCH' => Net::HTTP::Patch,
+      'DELETE' => Net::HTTP::Delete
+    }.freeze
+    HASH_ALGORITHM = "SHA256".freeze
+    HTTPS = 'https'.freeze
+    AMAZON_SIGNATURE_ALGORITHM = "AMZN-PAY-RSASSA-PSS-V2".freeze
+    AUTHORIZATION = 'authorization'.freeze
+    ACCEPT = 'accept'.freeze
+    CONTENT_TYPE = 'content-type'.freeze
+    APPLICATION_JSON = 'application/json'.freeze
+    X_AMZ_PAY_REGION = 'x-amz-pay-region'.freeze
+    X_AMZ_PAY_DATE = 'x-amz-pay-date'.freeze
+    X_AMZ_PAY_HOST = 'x-amz-pay-host'.freeze
+    CONTENT_LENGTH = 'content-length'.freeze
+    X_AMZ_PAY_SDK_TYPE = 'x-amz-pay-sdk-type'.freeze
+    X_AMZ_PAY_SDK_VERSION = 'x-amz-pay-sdk-version'.freeze
+    LIVE = 'LIVE-'
+    SANDBOX = 'SANDBOX-'
+    MERCHANT_ACCOUNTS_BASE_URL = 'merchantAccounts'.freeze
+    GET = 'GET'.freeze
+    POST = 'POST'.freeze
+    PATCH = 'PATCH'.freeze
+    DELETE = 'DELETE'.freeze
+    MAX_RETRIES = 3.freeze
+    BACKOFF_TIMES = [1, 2, 4].freeze # Define backoff times for retries
+    RETRYABLE_ERROR_CODES = [408, 425, 429, 500, 502, 503, 504].freeze
+    HTTP_OK = '200'
+    HTTP_SERVER_ERROR = '500'
+    BUYERS_URL = 'buyers'.freeze
+    CHECKOUT_SESSION_URL = 'checkoutSessions'.freeze
+    CHARGE_PERMISSIONS_URL = 'chargePermissions'.freeze
+    CHARGES_URL = 'charges'.freeze
+    REFUNDS_URL = 'refunds'.freeze
+    REPORTS = 'reports'.freeze
+    REPORT_SCHEDULES = 'report-schedules'.freeze
+    REPORT_DOCUMENTS = 'report-documents'.freeze
+    DISBURSEMENTS = 'disbursements'.freeze
+    DISPUTE_URLS = 'disputes'.freeze
+    FILES_URLS = 'files'.freeze
+    DISPUTE_FILING_REASON = {
+      PRODUCT_NOT_RECEIVED: "ProductNotReceived",
+      PRODUCT_UNACCEPTABLE: "ProductUnacceptable",
+      PRODUCT_NO_LONGER_NEEDED: "ProductNoLongerNeeded",
+      CREDIT_NOT_PROCESSED: "CreditNotProcessed",
+      OVERCHARGED: "Overcharged",
+      DUPLICATE_CHARGE: "DuplicateCharge",
+      SUBSCRIPTION_CANCELLED: "SubscriptionCancelled",
+      UNRECOGNIZED: "Unrecognized",
+      FRAUDULENT: "Fraudulent",
+      OTHER: "Other"
+    }.freeze
+    DISPUTE_REASON_CODE = {
+      MERCHANT_RESPONSE_REQUIRED: "MerchantResponseRequired",
+      MERCHANT_ADDITIONAL_EVIDENCES_REQUIRED: "MerchantAdditionalEvidencesRequired",
+      BUYER_ADDITIONAL_EVIDENCES_REQUIRED: "BuyerAdditionalEvidencesRequired",
+      MERCHANT_ACCEPTED_DISPUTE: "MerchantAcceptedDispute",
+      MERCHANT_RESPONSE_DEADLINE_EXPIRED: "MerchantResponseDeadlineExpired",
+      BUYER_CANCELLED: "BuyerCancelled",
+      INVESTIGATOR_RESOLVED: "InvestigatorResolved",
+      AUTO_RESOLVED: "AutoResolved",
+      CHARGEBACK_FILED: "ChargebackFiled"
+    }.freeze
+    DISPUTE_RESOLUTION = {
+      BUYER_WON: "BuyerWon",
+      MERCHANT_WON: "MerchantWon",
+      NO_FAULT: "NoFault"
+    }.freeze
+    DISPUTE_STATE = {
+      UNDER_REVIEW: "UnderReview",
+      ACTION_REQUIRED: "ActionRequired",
+      RESOLVED: "Resolved",
+      CLOSED: "Closed"
+    }.freeze
+    EVIDENCE_TYPE = {
+      PRODUCT_DESCRIPTION: "ProductDescription",
+      RECEIPT: "Receipt",
+      CANCELLATION_POLICY: "CancellationPolicy",
+      CUSTOMER_SIGNATURE: "CustomerSignature",
+      TRACKING_NUMBER: "TrackingNumber",
+      CARRIER_NAME: "CarrierName",
+      DEVICE_ID: "DeviceId",
+      DEVICE_NAME: "DeviceName",
+      DOWNLOAD_DATE_TIME: "DownloadDateTime",
+      OTHER: "Other"
+    }.freeze
+end

data/lib/amazon-pay-api-sdk-ruby/payment_service_provider_client.rb

@@ -0,0 +1,53 @@
+module PaymentServiceProviderClient
+    # API to create dispute. 
+    # The createDispute operation is used to notify Amazon of a newly created chargeback dispute by a buyer on a
+    # transaction processed only by the PSP (Payment Service Provider), ensuring the dispute is properly accounted for in the Amazon Pay systems.
+    # NOTE: This API is intended to be called only by PSPs (Payment Service Providers).
+    # @param {Object} payload - The payload containing statusDetails.
+    # @param {Object} headers - Requires : x-amz-pay-idempotency-key, Optional headers for the request, such as authorization tokens or custom headers.
+    # @return [HTTPResponse] The response from the API call, which includes details of the dispute.
+    def create_dispute(payload, headers: {});    
+        api_call(Constants::DISPUTE_URLS, Constants::POST, payload: payload, headers: headers)
+    end
+
+    # API to get dispute. 
+    # The getDispute operation is used to retrieve details of a chargeback dispute associated with a specific order
+    # @param {Object} headers - Optional headers for the request, such as x-amz-pay-idempotency-key, authorization tokens or custom headers.
+    # @return [HTTPResponse] The response from the API call, which includes details of the dispute.
+    def get_dispute(dispute_id, headers: {});    
+        api_call("#{Constants::DISPUTE_URLS}/#{dispute_id}", Constants::GET, headers: headers)
+    end
+
+    # API to update dispute. 
+    # The updateDispute operation is used to notify Amazon of the closure status of a chargeback dispute initiated by a
+    # buyer for orders, ensuring proper accounting within the Amazon systems.
+    # @param {String} dispute_id - The unique ID of the dispute to retrieve.
+    # @param {Object} payload - The payload containing statusDetails.
+    # @param {Object} headers - Optional headers for the request, such as x-amz-pay-idempotency-key, authorization tokens or custom headers.
+    # @return [HTTPResponse] The response from the API call, which includes details of the dispute.
+    def update_dispute(dispute_id, payload, headers: {});    
+        api_call("#{Constants::DISPUTE_URLS}/#{dispute_id}", Constants::PATCH, payload: payload, headers: headers)
+    end
+
+    # API to contest dispute.
+    # The contestDispute operation is used by the partner, on behalf of the merchant, to formally contest a dispute
+    # managed by Amazon, requiring the submission of necessary evidence files within the specified
+    # Dispute Window (11 days for Chargeback, 7 days for A-Z Claims).
+    # @param {String} dispute_id - The unique ID of the dispute to retrieve.
+    # @param {Object} payload - The payload containing statusDetails.
+    # @param {Object} headers - Optional headers for the request, such as x-amz-pay-idempotency-key, authorization tokens or custom headers.
+    # @return [HTTPResponse] The response from the API call, which includes details of the dispute.
+    def contest_dispute(dispute_id, payload, headers: {});    
+        api_call("#{Constants::DISPUTE_URLS}/#{dispute_id}/contest", Constants::POST, payload: payload, headers: headers)
+    end
+
+    # API to upload file.
+    # The uploadFile operation is utilised to upload file-based evidence when a
+    # merchant contests a dispute, providing the necessary reference ID to the evidence file as part of
+    # the Update Dispute API process.
+    # @param {Object} headers - Requires : x-amz-pay-idempotency-key, Optional headers for the request, such as authorization tokens or custom headers.
+    # @return [HTTPResponse] The response from the API call, which includes details of the file.
+    def upload_file(payload, headers: {});    
+        api_call(Constants::FILES_URLS, Constants::POST, payload: payload, headers: headers)
+    end
+end  

data/lib/amazon-pay-api-sdk-ruby.rb

@@ -0,0 +1,3 @@
+require_relative './amazon-pay-api-sdk-ruby/client'
+require_relative './amazon-pay-api-sdk-ruby/client_helper'
+require_relative "./amazon-pay-api-sdk-ruby/constants"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amazon-pay-api-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.1.0
 platform: ruby
 authors:
 - AmazonPay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-06 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -31,7 +31,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -46,10 +46,11 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/amazon_pay.rb
-- lib/amazon_pay/client.rb
-- lib/amazon_pay/client_helper.rb
-- lib/amazon_pay/constants.rb
+- lib/amazon-pay-api-sdk-ruby.rb
+- lib/amazon-pay-api-sdk-ruby/client.rb
+- lib/amazon-pay-api-sdk-ruby/client_helper.rb
+- lib/amazon-pay-api-sdk-ruby/constants.rb
+- lib/amazon-pay-api-sdk-ruby/payment_service_provider_client.rb
 homepage: https://rubygems.org/gems/amazon-pay-api-sdk-ruby
 licenses:
 - Apache-2.0

data/lib/amazon_pay/constants.rb

@@ -1,53 +0,0 @@
-require 'net/http'
-
-module Constants
-    SDK_TYPE = "amazon-pay-api-sdk-ruby".freeze
-    SDK_VERSION = "1.2.0".freeze
-    API_VERSION = "v2".freeze
-    API_ENDPOINTS = {
-      'na' => 'pay-api.amazon.com',
-      'eu' => 'pay-api.amazon.eu',
-      'jp' => 'pay-api.amazon.jp'
-    }.freeze
-    METHOD_TYPES = {
-      'GET' => Net::HTTP::Get,
-      'POST' => Net::HTTP::Post,
-      'PUT' => Net::HTTP::Put,
-      'PATCH' => Net::HTTP::Patch,
-      'DELETE' => Net::HTTP::Delete
-    }.freeze
-    HASH_ALGORITHM = "SHA256".freeze
-    HTTPS = 'https'.freeze
-    AMAZON_SIGNATURE_ALGORITHM = "AMZN-PAY-RSASSA-PSS-V2".freeze
-    AUTHORIZATION = 'authorization'.freeze
-    ACCEPT = 'accept'.freeze
-    CONTENT_TYPE = 'content-type'.freeze
-    APPLICATION_JSON = 'application/json'.freeze
-    X_AMZ_PAY_REGION = 'x-amz-pay-region'.freeze
-    X_AMZ_PAY_DATE = 'x-amz-pay-date'.freeze
-    X_AMZ_PAY_HOST = 'x-amz-pay-host'.freeze
-    CONTENT_LENGTH = 'content-length'.freeze
-    X_AMZ_PAY_SDK_TYPE = 'x-amz-pay-sdk-type'.freeze
-    X_AMZ_PAY_SDK_VERSION = 'x-amz-pay-sdk-version'.freeze
-    LIVE = 'LIVE-'
-    SANDBOX = 'SANDBOX-'
-    MERCHANT_ACCOUNTS_BASE_URL = 'merchantAccounts'.freeze
-    GET = 'GET'.freeze
-    POST = 'POST'.freeze
-    PATCH = 'PATCH'.freeze
-    DELETE = 'DELETE'.freeze
-    MAX_RETRIES = 3.freeze
-    BACKOFF_TIMES = [1, 2, 4].freeze # Define backoff times for retries
-    RETRYABLE_ERROR_CODES = [408, 429, 500, 502, 503, 504].freeze
-    HTTP_OK = '200'
-    HTTP_SERVER_ERROR = '500'
-    BUYERS_URL = 'buyers'.freeze
-    CHECKOUT_SESSION_URL = 'checkoutSessions'.freeze
-    CHARGE_PERMISSIONS_URL = 'chargePermissions'.freeze
-    CHARGES_URL = 'charges'.freeze
-    REFUNDS_URL = 'refunds'.freeze
-    REPORTS = 'reports'.freeze
-    REPORT_SCHEDULES = 'report-schedules'.freeze
-    REPORT_DOCUMENTS = 'report-documents'.freeze
-    DISBURSEMENTS = 'disbursements'.freeze
-end

data/lib/amazon_pay.rb

@@ -1,3 +0,0 @@
-require_relative './amazon_pay/client'
-require_relative './amazon_pay/client_helper'
-require_relative "./amazon_pay/constants"