sift 4.1.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b20b0230176dc6340e5ea4939e51b6e1ed2642e788c25fa2f7f4e829b5c61ff
-  data.tar.gz: 28932a0fddd658fe868c6c6b6b408ab1d8529060cfbe0766ffeef76e2398e43e
+  metadata.gz: 0be867318fbb8cb5cb85b614e48de3748def9c8d9a6122c066c785d65c6b3b48
+  data.tar.gz: abf0fe3da0bbf939f29cdb1071e9acb7db62473bc9fdc37dcde52631db930abc
 SHA512:
-  metadata.gz: b905f6002c28777a4cf82cc6b0e59b2c79c300fdf1f4b4b3bf8b0bff8691946325d83794da812d5abc4b344b5e35d24f72b720aae1ddc0783b7e935117f35588
-  data.tar.gz: e161d32f1c210f3fc4562b985537ceb6e2f304330a3fb14ddbce142cd105b0a0c567f6e177dd3c29c99e6c50133e3a7eb40c5ba922071914d9cf56b540c8f427
+  metadata.gz: cc2d9d80295f6f4605413d001bb29b4745e28ecc58e9595a526bd8a7d8529d2b63dc14fce063e1ee347bde3b9d9370ad160917a795e59377a54d5eeb50f876b7
+  data.tar.gz: f5f75423865db471ed649a4146a8e3e388203977ec6607c20966c9622f9b074f8e149574f9bbe28db22f44b21203e9ae082b52386bea6f8c2096afd869955a65

data/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+## Purpose
+
+## Summary
+
+## Testing
+
+## Checklist
+- [ ] The change was thoroughly tested manually
+- [ ] The change was covered with unit tests
+- [ ] The change was tested with real API calls (if applicable)
+- [ ] Necessary changes were made in the integration tests (if applicable)
+- [ ] New functionality is reflected in README

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: Ruby-ci
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+env:
+  ACCOUNT_ID: ${{ secrets.ACCOUNT_ID }}
+  API_KEY: ${{ secrets.API_KEY }}
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4.2']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rspec --format RspecJunitFormatter --out test_results/rspec.xml --format progress
+
+  run_integration_tests:
+    runs-on: ubuntu-latest
+    if: ${{ github.ref == 'refs/heads/master' }}
+    strategy:
+      matrix:
+        ruby-version: [ '2.4.2' ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: |
+          bundle exec ruby test_integration_app/main.rb 

data/.github/workflows/publishing_sift_ruby.yml

@@ -0,0 +1,38 @@
+name: Build and Publish Gem
+on:
+  release:
+    types: [published]
+
+env:
+  GH_TOKEN: ${{ github.token }}
+
+jobs:
+  build_and_publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Install Bundler
+        run: |
+          sudo gem install bundler
+          bundle install
+      - name: Build and push gem
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${{ secrets.GH_RGEMS_KEY }}\n" > $HOME/.gem/credentials
+          version=$(awk -F'"' '/ VERSION = / {print $2}' < lib/sift/version.rb)
+          all_versions=$(gem list -r -e --all sift --no-verbose)
+          if [[ $all_versions != *"$version"* ]]; then
+              echo "Gem version does not exist on RubyGems. Building and pushing!"
+              gem build sift.gemspec
+              gem push sift-$version.gem
+              rm -rf $HOME/.gem
+          else
+              echo "Gem version $version exists on RubyGems"
+          fi

data/.gitignore

@@ -3,3 +3,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.idea

data/HISTORY

@@ -1,3 +1,19 @@
+=== 4.5.1 2025-04-07
+- Fix Verification URLs
+
+=== 4.5.0 2024-05-16
+- Support for warnings in Events API
+
+=== 4.4.0 2023-10-05
+- Score percentiles in Score API
+
+=== 4.3.0 2023-08-21
+- PSP Merchant Management API
+
+=== 4.2.0 2023-06-20
+- Verification API support [Verification API](https://sift.com/developers/docs/curl/verification-api/overview)
+- Support for score percentiles (only applicable for the accounts with the feature enabled)
+
 === 4.1.0 2022-06-22
 - Add return_route_info query param
 

data/README.md

@@ -1,5 +1,4 @@
 # sift-ruby
-[![CircleCI](https://circleci.com/gh/SiftScience/sift-ruby.svg?style=svg)](https://circleci.com/gh/SiftScience/sift-ruby)
 
 The official Ruby bindings for the latest version (v205) of the [Sift API](https://sift.com/developers/docs/java/apis-overview).
 
@@ -39,8 +38,22 @@ client = Sift::Client.new(api_key: '<your_api_key_here>', account_id: '<your_acc
 
 ```
 
-### Sending a transaction event
+### Sending an event
+Send event to Sift.
+To learn more about the Events API visit our [developer docs](https://developers.sift.com/docs/ruby/events-api/overview).
 
+
+**Optional Params**
+- `return_score`: `:true` or `:false`
+- `return_action`: `:true` or `:false`
+- `return_workflow_status`: `:true` or `:false`
+- `return_route_info`: `:true` or `:false`
+- `force_workflow_run`: `:true` or `:false`
+- `include_score_percentiles`: `:true` or `:false`
+- `warnings`: `:true` or `:false`
+- `abuse_types`: `["payment_abuse", "content_abuse", "content_abuse", "account_abuse", "legacy", "account_takeover"]`
+
+**Example:**
 ```ruby
 event = "$transaction"
 
@@ -217,6 +230,72 @@ response = client.get_session_decisions('example_user_id', 'example_session_id')
 response = client.get_content_decisions('example_user_id', 'example_order_id')
 ```
 
+## PSP Merchant Management API
+
+To learn more about the decisions endpoint visit our [developer docs](https://sift.com/developers/docs/ruby/psp-merchant-management-api).
+
+```ruby
+# On-board a PSP merchant summary to Sift Platform.
+# Sample psp_merchant_profile
+  properties = {
+    "id": "merchant_id_01000",
+    "name": "Wonderful Payments Inc.",
+    "description": "Wonderful Payments payment provider.",
+    "address": {
+      "name": "Alany",
+      "address_1": "Big Payment blvd, 22",
+      "address_2": "apt, 8",
+      "city": "New Orleans",
+      "region": "NA",
+      "country": "US",
+      "zipcode": "76830",
+      "phone": "0394888320"
+    },
+    "category": "1002",
+    "service_level": "Platinum",
+    "status": "active",
+    "risk_profile": {
+      "level": "low",
+      "score": 10
+    }
+  }
+response = client.create_psp_merchant_profile(properties)
+
+# Update a merchant summary to reflect changes in the status or service level or address etc.
+  properties = {
+    "id": "merchant_id_01000",
+    "name": "Wonderful Payments Inc.",
+    "description": "Wonderful Payments payment provider.",
+    "address": {
+      "name": "Alany",
+      "address_1": "Big Payment blvd, 22",
+      "address_2": "apt, 8",
+      "city": "New Orleans",
+      "region": "NA",
+      "country": "US",
+      "zipcode": "76830",
+      "phone": "0394888320"
+    },
+    "category": "1002",
+    "service_level": "Platinum",
+    "status": "active",
+    "risk_profile": {
+      "level": "low",
+      "score": 10
+    }
+  }
+response = client.update_psp_merchant_profile('merchant_id', properties)
+
+# Get the existing PSP merchant summaries.
+response = client.get_a_psp_merchant_profile('merchant_id')
+
+# Get all PSP merchant summaries
+response = client.get_psp_merchant_profiles()
+
+# Get PSP merchant summaries paginated 
+response = client.get_psp_merchant_profiles('batch_size', 'batch_token')
+```
+
 ## Response Object
 
 All requests to our apis will return a `Response` instance.
@@ -252,3 +331,21 @@ To run the various tests use the rake command as follows:
 ```ruby
 $ rake spec
 ```
+
+## Integration testing app
+
+For testing the app with real calls it is possible to run the integration testing app,
+it makes calls to almost all our public endpoints to make sure the library integrates
+well. At the moment, the app is run on every merge to master
+
+#### How to run it locally
+
+1. Add env variable `ACCOUNT_ID` with the valid account id
+2. Add env variable `API_KEY` with the valid Api Key associated from the account
+3. Run the following under the project root folder
+```
+# Install the budle locally
+bundle check || bundle install
+# Run the app
+bundle exec ruby test_integration_app/main.rb
+```

data/examples/psp_merchant_management_apis.rb

@@ -0,0 +1,105 @@
+require 'rubygems'
+require 'sift'
+require 'multi_json'
+
+class MyLogger
+  def warn(e)
+    puts "[WARN]  " + e.to_s
+  end
+
+  def error(e)
+    puts "[ERROR] " + e.to_s
+  end
+
+  def fatal(e)
+    puts "[FATAL] " + e.to_s
+  end
+
+  def info(e)
+    puts "[INFO]  " + e.to_s
+  end
+end
+
+def handle_response(response)
+  if response.nil?
+    puts 'Error: there was an HTTP error calling through the API'
+  else
+    puts 'Successfully sent request; was ok? : ' + response.ok?.to_s
+    puts 'API error message                  : ' + response.api_error_message.to_s
+    puts 'API status code                    : ' + response.api_status.to_s
+    puts 'HTTP status code                   : ' + response.http_status_code.to_s
+    puts 'original request                   : ' + response.original_request.to_s
+    puts 'response body                      : ' + response.body.to_s
+  end
+end
+
+Sift.logger = MyLogger.new
+
+$api_key = 'put-valid-api-key'
+$account_id = 'put-valid-account-id'
+
+def post_merchant_properties
+  # Sample psp_merchant_profile
+  {
+    "id": "merchant_id_01004",
+    "name": "Wonderful Payments Inc.",
+    "description": "Wonderful Payments payment provider.",
+    "address": {
+      "name": "Alany",
+      "address_1": "Big Payment blvd, 22",
+      "address_2": "apt, 8",
+      "city": "New Orleans",
+      "region": "NA",
+      "country": "US",
+      "zipcode": "76830",
+      "phone": "0394888320"
+    },
+    "category": "1002",
+    "service_level": "Platinum",
+    "status": "active",
+    "risk_profile": {
+      "level": "low",
+      "score": 10
+    }
+  }
+end
+
+def put_merchant_properties
+  # Sample update psp_merchant_profile
+  {
+    "id": "merchant_id_01004",
+    "name": "Wonderful Payments Inc. update",
+    "description": "Wonderful Payments payment provider. update",
+    "address": {
+      "name": "Alany",
+      "address_1": "Big Payment blvd, 22",
+      "address_2": "apt, 8",
+      "city": "New Orleans",
+      "region": "NA",
+      "country": "US",
+      "zipcode": "76830",
+      "phone": "0394888320"
+    },
+    "category": "1002",
+    "service_level": "Platinum",
+    "status": "active",
+    "risk_profile": {
+      "level": "low",
+      "score": 10
+    }
+  }
+end
+
+# handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).create_psp_merchant_profile(post_merchant_properties)
+
+# handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).update_psp_merchant_profile("merchant_id_01004", put_merchant_properties)
+
+# handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).get_a_psp_merchant_profile("merchant_id_01004")
+
+# handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).get_psp_merchant_profiles()
+
+# handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).get_psp_merchant_profiles(2)
+
+handle_response Sift::Client.new(:api_key => $api_key, :account_id => $account_id).get_psp_merchant_profiles(5, "next_ref")
+
+puts "request completed"

data/examples/validation_apis.rb

@@ -0,0 +1,47 @@
+require "sift"
+require 'multi_json'
+
+#$api_key = "put-a-valid-apikey"
+#$user_id = "put-a-valid-userid"
+
+def valid_send_properties
+    {
+      :$user_id => $user_id,
+	  :$send_to => $user_id,
+      :$verification_type => '$email',
+      :$brand_name => 'all',
+      :$language => 'en',
+      :$event => {
+                :$session_id => 'gigtleqddo84l8cm15qe4il',
+                :$verified_event => '$login',
+                :$reason => '$automated_rule',
+                :$ip => '192.168.1.1',
+                :$browser => {
+                    :$user_agent => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36'
+                }
+            }
+    }
+end
+
+def valid_resend_properties
+    {
+      :$user_id => $user_id,
+      :$verified_event => '$login'
+    }
+end
+
+def valid_check_properties
+    {
+      :$user_id => $user_id,
+      :$code => '668316'
+    }
+end
+
+  #response = Sift::Client.new(:api_key => $api_key,:user_id => $user_id,:version=>1.1).verification_send(valid_send_properties)
+
+  #response = Sift::Client.new(:api_key => $api_key,:user_id => $user_id,:version=>1.1).verification_resend(valid_resend_properties)
+  response = Sift::Client.new(:api_key => $api_key,:user_id => $user_id,:version=>1.1).verification_check(valid_check_properties)
+
+  p response
+
+  puts "completed"

data/lib/sift/client.rb

@@ -139,6 +139,7 @@ module Sift
       @api_key = opts[:api_key] || Sift.api_key
       @account_id = opts[:account_id] || Sift.account_id
       @version = opts[:version] || API_VERSION
+      @verification_version = opts[:verification_version] || VERIFICATION_API_VERSION
       @timeout = opts[:timeout] || 2  # 2-second timeout by default
       @path = opts[:path] || Sift.rest_api_path(@version)
 
@@ -202,6 +203,12 @@ module Sift
     #   :path::
     #     Overrides the URI path for this API call.
     #
+    #   :include_score_percentiles::
+    #     include_score_percentiles(optional) : Whether to add new parameter in the query parameter.
+    #
+    #   :warnings::
+    #     warnings(optional) : Whether to add list of warnings (if any) to response.
+    #
     # ==== Returns:
     #
     # In the case of a network error (timeout, broken connection, etc.),
@@ -219,6 +226,8 @@ module Sift
       return_route_info = opts[:return_route_info]
       force_workflow_run = opts[:force_workflow_run]
       abuse_types = opts[:abuse_types]
+      include_score_percentiles = opts[:include_score_percentiles]
+      warnings = opts[:warnings]
 
       raise("event must be a non-empty string") if (!event.is_a? String) || event.empty?
       raise("properties cannot be empty") if properties.empty?
@@ -232,6 +241,13 @@ module Sift
       query["force_workflow_run"] = "true" if force_workflow_run
       query["abuse_types"] = abuse_types.join(",") if abuse_types
 
+      if include_score_percentiles == "true" || warnings == "true"
+        fields = []
+        fields << "SCORE_PERCENTILES" if include_score_percentiles == "true"
+        fields << "WARNINGS" if warnings == "true"
+        query["fields"] = fields.join(",")
+      end
+
       options = {
         :body => MultiJson.dump(delete_nils(properties).merge({"$type" => event,
                                                                "$api_key" => api_key})),
@@ -272,6 +288,9 @@ module Sift
     #   :version::
     #     Overrides the version of the Events API to call.
     #
+    #   :include_score_percentiles::
+    #     include_score_percentiles(optional) : Whether to add new parameter in the query parameter.
+    #
     # ==== Returns:
     #
     # A Response object containing a status code, status message, and,
@@ -282,6 +301,7 @@ module Sift
       api_key = opts[:api_key] || @api_key
       timeout = opts[:timeout] || @timeout
       version = opts[:version] || @version
+      include_score_percentiles = opts[:include_score_percentiles]
 
       raise("user_id must be a non-empty string") if (!user_id.is_a? String) || user_id.to_s.empty?
       raise("Bad api_key parameter") if api_key.empty?
@@ -289,6 +309,9 @@ module Sift
       query = {}
       query["api_key"] = api_key
       query["abuse_types"] = abuse_types.join(",") if abuse_types
+      if include_score_percentiles == "true"
+        query["fields"] =  "SCORE_PERCENTILES"
+      end
 
       options = {
         :headers => {"User-Agent" => user_agent},
@@ -329,6 +352,9 @@ module Sift
     #   :timeout::
     #     Overrides the timeout (in seconds) for this call.
     #
+    #   :include_score_percentiles::
+    #     include_score_percentiles(optional) : Whether to add new parameter in the query parameter.
+    #
     # ==== Returns:
     #
     # A Response object containing a status code, status message, and,
@@ -338,6 +364,7 @@ module Sift
       abuse_types = opts[:abuse_types]
       api_key = opts[:api_key] || @api_key
       timeout = opts[:timeout] || @timeout
+      include_score_percentiles = opts[:include_score_percentiles]
 
       raise("user_id must be a non-empty string") if (!user_id.is_a? String) || user_id.to_s.empty?
       raise("Bad api_key parameter") if api_key.empty?
@@ -345,6 +372,9 @@ module Sift
       query = {}
       query["api_key"] = api_key
       query["abuse_types"] = abuse_types.join(",") if abuse_types
+      if include_score_percentiles == "true"
+        query["fields"] =  "SCORE_PERCENTILES"
+      end
 
       options = {
         :headers => {"User-Agent" => user_agent},
@@ -716,6 +746,175 @@ module Sift
       handle_response(apply_decision(configs))
     end
 
+    def build_default_headers_post(api_key)
+      {
+        "Authorization" => "Basic #{Base64.encode64(api_key+":")}",
+        "User-Agent" => "SiftScience/v#{@version} sift-ruby/#{VERSION}",
+        "Content-Type" => "application/json"
+      }
+    end
+
+    def verification_send(properties = {}, opts = {})
+      api_key = opts[:api_key] || @api_key
+      version = opts[:verification_version] || @verification_version
+      timeout = opts[:timeout] || @timeout
+
+      raise("properties cannot be empty") if properties.empty?
+      raise("api_key cannot be empty") if api_key.empty?
+
+
+      options = {
+        :body => MultiJson.dump(delete_nils(properties)),
+        :headers => build_default_headers_post(api_key)
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+      response = self.class.post(Sift.verification_api_send_path(@version), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+    def verification_resend(properties = {}, opts = {})
+      api_key = opts[:api_key] || @api_key
+      version = opts[:verification_version] || @verification_version
+      timeout = opts[:timeout] || @timeout
+
+      raise("properties cannot be empty") if properties.empty?
+      raise("api_key cannot be empty") if api_key.empty?
+
+
+      options = {
+        :body => MultiJson.dump(delete_nils(properties)),
+        :headers => build_default_headers_post(api_key)
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+
+      response = self.class.post(Sift.verification_api_resend_path(@version), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+    def verification_check(properties = {}, opts = {})
+      api_key = opts[:api_key] || @api_key
+      version = opts[:verification_version] || @verification_version
+      timeout = opts[:timeout] || @timeout
+
+      raise("properties cannot be empty") if properties.empty?
+      raise("api_key cannot be empty") if api_key.empty?
+
+
+      options = {
+        :body => MultiJson.dump(delete_nils(properties)),
+        :headers => build_default_headers_post(api_key)
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+
+      response = self.class.post(Sift.verification_api_check_path(@version), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+    def create_psp_merchant_profile(properties = {}, opts = {})
+      # Create a new PSP Merchant profile
+      # Args:
+      #   properties: A dict of merchant profile data.
+      # Returns
+      #   A sift.client.Response object if the call succeeded, else raises an ApiException
+
+      account_id = opts[:account_id] || @account_id
+      api_key = opts[:api_key] || @api_key
+      timeout = opts[:timeout] || @timeout
+
+      raise("api_key cannot be empty") if api_key.empty?
+      raise("account_id cannot be empty") if account_id.empty?
+      raise("properties cannot be empty") if properties.empty?
+
+      options = {
+        :body => MultiJson.dump(delete_nils(properties)),
+        :headers => { "User-Agent" => user_agent, "Content-Type" => "application/json" },
+        :basic_auth => { :username => api_key, :password => "" }
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+      response = self.class.post(API_ENDPOINT + Sift.psp_merchant_api_path(account_id), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+    def update_psp_merchant_profile(merchant_id, properties = {}, opts = {})
+      # Update an existing PSP Merchant profile
+      #  Args:
+      #      merchant_id: id of merchant
+      #      properties: A dict of merchant profile data.
+      #  Returns
+      #      A sift.client.Response object if the call succeeded, else raises an ApiException
+
+      account_id = opts[:account_id] || @account_id
+      api_key = opts[:api_key] || @api_key
+      timeout = opts[:timeout] || @timeout
+
+      raise("api_key cannot be empty") if api_key.empty?
+      raise("account_id cannot be empty") if account_id.empty?
+      raise("merchant_id cannot be empty") if merchant_id.empty?
+      raise("properties cannot be empty") if properties.empty?
+
+      options = {
+        :body => MultiJson.dump(delete_nils(properties)),
+        :headers => { "User-Agent" => user_agent, "Content-Type" => "application/json" },
+        :basic_auth => { :username => api_key, :password => "" }
+      }
+      options.merge!(:timeout => timeout) unless timeout.nil?
+      response = self.class.put(API_ENDPOINT + Sift.psp_merchant_id_api_path(account_id, merchant_id), options)
+      Response.new(response.body, response.code, response.response)
+    end
+
+  def get_a_psp_merchant_profile(merchant_id, opts = {})
+    # Gets a PSP merchant profile using merchant id.
+    #  Args:
+    #      merchant_id: id of merchant
+    #  Returns
+    #      A sift.client.Response object if the call succeeded, else raises an ApiException
+
+    account_id = opts[:account_id] || @account_id
+    api_key = opts[:api_key] || @api_key
+    timeout = opts[:timeout] || @timeout
+    
+    raise("api_key cannot be empty") if api_key.empty?
+    raise("account_id cannot be empty") if account_id.empty?
+    raise("merchant_id cannot be empty") if merchant_id.empty?
+
+    options = {
+      :headers => { "User-Agent" => user_agent, "Content-Type" => "application/json" },
+      :basic_auth => { :username => api_key, :password => "" }
+    }
+    options.merge!(:timeout => timeout) unless timeout.nil?
+    response = self.class.get(API_ENDPOINT + Sift.psp_merchant_id_api_path(account_id, merchant_id), options)
+    Response.new(response.body, response.code, response.response)
+  end
+
+  def get_psp_merchant_profiles(batch_size = nil, batch_token = nil, opts = {})
+    # Get all PSP merchant profiles.
+    # Args:
+    #  batch_size : Batch or page size of the paginated sequence.
+    #  batch_token : Batch or page position of the paginated sequence.
+    #  Returns
+    #      A sift.client.Response object if the call succeeded, else raises an ApiException
+
+    account_id = opts[:account_id] || @account_id
+    api_key = opts[:api_key] || @api_key
+    timeout = opts[:timeout] || @timeout
+
+    raise("api_key cannot be empty") if api_key.empty?
+    raise("account_id cannot be empty") if account_id.empty?
+
+    query = {}
+    query["batch_size"] = batch_size if batch_size
+    query["batch_token"] = batch_token if batch_token
+
+    options = {
+      :headers => { "User-Agent" => user_agent, "Content-Type" => "application/json" },
+      :basic_auth => { :username => api_key, :password => "" },
+      :query => query
+    }
+    options.merge!(:timeout => timeout) unless timeout.nil?
+    response = self.class.get(API_ENDPOINT + Sift.psp_merchant_api_path(account_id), options)
+    Response.new(response.body, response.code, response.response)
+  end
+
     private
 
     def handle_response(response)