Added Payment Feedback API

Author: garychewter

docs/source/code.md

@@ -111,6 +111,7 @@ Retrieve geolocation information for an IP address.
 | username    | string | (optional) User's username.                                             |
 | email       | string | (optional) User's email address.                                        |
 | phone       | string | (optional) User's phone number.                                         |
+| bill_to       | string  | (optional) Billing details such as company name. |
 | bill_addr       | string  | (optional) Street address of billing address. |
 | bill_city       | string  | (optional) City of billing address. |
 | bill_state      | string  | (optional) State of billing address. It supports state codes, e.g. NY (New York), for state or province of United States or Canada.|
@@ -246,4 +247,33 @@ Get SMS Verification result.
 | Parameter         | Type   | Description |
 |-------------------|--------|-------------|
 | result           | string | Indicates if the input parameters matched a valid OTP. Y if a valid OTP is found and N if no valid OTP found. |
-```
+```
+
+## Payment Class
+```{py:class} Payment(config_object)
+Initiate Payment class.
+
+:param object config_object: (Required) The configuration object returned by Configuration Class.
+```
+
+```{py:function} feedback(params)
+Report the final payment status back to the system, helping improve fraud detection and risk assessment
+
+:param str params: (Required) Parameters of feedback details.
+
+| Parameter    | Type    | Description |
+|--------------|---------|---------------------|
+| email        | string  | (required) Email address of the payment order. |
+| status       | string  | (required) Status of the payment order. |
+| message      | string  | (required) Message returned from the payment gateway for the payment order. |
+| fraudlabspro_id | string | (optional) Unique transaction Id generated by Fraud Check API. |
+
+
+:return: Returns the details about the feedback in JSON object.
+:rtype: Object
+
+| Parameter         | Type   | Description |
+|-------------------|--------|-------------|
+| result            | string | Indicates if submission is successful. |
+
+```

docs/source/quickstart.md

@@ -119,4 +119,21 @@ result = FraudlabsproRuby::Api::SMSVerification.verifySMS(
   tran_id: 'UNIQUE_TRANS_ID',
   otp: 'OTP_RECEIVED'
 )
+```
+
+### Payment Feedback
+
+You can report payment gateway feedback as below:
+
+```ruby
+require 'fraudlabspro_ruby'
+
+FraudlabsproRuby::Configuration.api_key = 'YOUR_API_KEY'
+
+result = FraudlabsproRuby::Api::Payment.feedback(
+  email: '[email protected]',
+  status: 'declined',
+  message: 'Call Issuer. Pick Up Card. (2047)',
+  fraudlabspro_id: '20260131-O263CR'
+)
 ```

fraudlabspro_ruby.gemspec

@@ -29,11 +29,13 @@ Gem::Specification.new do |s|
     "lib/fraudlabspro_ruby/api.rb",
     "lib/fraudlabspro_ruby/api/order.rb",
     "lib/fraudlabspro_ruby/api/smsverification.rb",
+    "lib/fraudlabspro_ruby/api/payment.rb",
     "lib/fraudlabspro_ruby/configuration.rb",
     "lib/fraudlabspro_ruby/version.rb",
     "spec/spec_helper.rb",
     "spec/fraudlabspro_ruby_fraudvalidation_spec.rb",
-    "spec/fraudlabspro_ruby_smsverification_spec.rb"
+    "spec/fraudlabspro_ruby_smsverification_spec.rb",
+    "spec/fraudlabspro_ruby_payment_spec.rb"
   ]
   if s.respond_to?(:metadata=)
     s.metadata = {

lib/fraudlabspro_ruby.rb

@@ -1,6 +1,7 @@
 require "fraudlabspro_ruby/api"
 require "fraudlabspro_ruby/api/order"
 require "fraudlabspro_ruby/api/smsverification"
+require "fraudlabspro_ruby/api/payment"
 require "fraudlabspro_ruby/configuration"
 require "fraudlabspro_ruby/version"
 

lib/fraudlabspro_ruby/api/order.rb

@@ -65,6 +65,7 @@ def self.validate(params = {})
           'email' => params[:email] || '',
           'email_domain' => email_domain || '',
           'user_phone' => params[:phone] || '',
+          'bill_to' => params[:bill_to] || '',
           'bill_addr' => params[:bill_addr] || '',
           'bill_city' => params[:bill_city] || '',
           'bill_state' => params[:bill_state] || '',

lib/fraudlabspro_ruby/api/payment.rb

@@ -0,0 +1,38 @@
+require 'uri'
+require 'net/http'
+require "fraudlabspro_ruby/configuration"
+require "fraudlabspro_ruby/version"
+
+module FraudlabsproRuby
+  module Api
+    class Payment
+
+      # Report the final payment status back to the system, helping improve fraud detection and risk assessment.
+      def self.feedback(params = {})
+        uri = URI.parse("https://api.fraudlabspro.com/v2/payment/feedback")
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        request = Net::HTTP::Post.new(uri.request_uri)
+        request.set_form_data({
+          'key' => FraudlabsproRuby::Configuration.api_key,
+          'format' => 'json',
+          'source' => 'sdk-ruby',
+          'source_version' => FraudlabsproRuby::VERSION,
+          'email' => params[:email],
+          'status' => params[:status],
+          'message' => params[:message],
+          'fraudlabspro_id' => params[:fraudlabspro_id] || ''
+        })
+
+        response = http.request(request)
+
+        if response == nil
+          return false
+        else
+          return response
+        end
+      end
+
+    end
+  end
+end

lib/fraudlabspro_ruby/version.rb

@@ -1,3 +1,3 @@
 module FraudlabsproRuby
-  VERSION = "4.0.1"
+  VERSION = "4.1.0"
 end

spec/fraudlabspro_ruby_payment_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FraudlabsproRuby" do
+  it "work correctly with payment feedback" do
+    FraudlabsproRuby::Configuration.api_key = $test_api_key
+    result = FraudlabsproRuby::Api::Payment.feedback(
+      email: '',
+      status: 'declined',
+      message: 'Call Issuer. Pick Up Card. (2047)'
+    )
+    data = JSON.parse(result.body)
+    if $test_api_key == 'YOUR_API_KEY'
+      expect(data['error']['error_message']).to eq 'INVALID API KEY'
+    else
+      expect(data['error']['error_message']).to eq 'INVALID EMAIL ADDRESS'
+    end
+  end
+
+end