blockchyp 2.16.5 → 2.17.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 898acc6744b68f3722a4df56bec008ba7c2f52a4f1e12d3c008b6beeafd1b999
-  data.tar.gz: 1f662e1e7cb54df1f7d22378cea7ec850b6ab64a571f3097b71adaa6d8e56071
+  metadata.gz: 29b33f7fd1e00ed4cdb89c46257f6c39916b4fa081c0dbe3bcdb42163dd39a2b
+  data.tar.gz: 467417b125257bec67021c1d1d3f89db422499526d936b1b8dae0fefa45b8d7d
 SHA512:
-  metadata.gz: 003d1422ad36e95736d6d43f326754e14a6101840dab3b8354cd5c2e4844c8ded1b1cfe6b082cd97890bc3641b7700534b56262bf8c8a2cccab72422d4e2d6ee
-  data.tar.gz: a068009ac83fc6101d2e8aadf8e3650258946b5e8045a1c3d4118ebc2f1ab1f55af68ed35180670027d806d338a33af3156b52b6596eda53a67187cead9b6473
+  metadata.gz: 0f195cc07b54b5f1a208d05ff267afa6bf5bdd48a0780726e9b879e7589343b86a382b4a3cc1d86d336f13113490ef527a6043e5c7530b1d3888c55cfe8f199e
+  data.tar.gz: 2814d47d23946603ca589a4b52d611398d591d00605b9466da09a5ca787f62159e3936e40001bd37331cafeac1fec40fc57cae4ced9f505953658d6682073aa4

data/README.md

@@ -3942,6 +3942,268 @@ puts "Response: #{response.inspect}"
 
 ```
 
+### Partner Utilities
+
+
+These partner only APIs give ISV partners advanced reporting and tools for managing their portfolio.
+
+Most of the APIs below are for portfolio reporting and range from basic partner commission statements
+to individual statements with all underlying card brand data.
+
+We also provide a pricing policy API that enables partners to pull down the current pricing rules
+in force for any merchant in their portfolio.
+
+<aside class="info">
+<b>Currency Data</b>
+<p>
+All partner APIs return currency and percentage values in two formats: floating point and formatted strings.
+</p>
+<p>
+It's recommended that all developers use the formatted string as this will ensure the most precise values.
+Floating point numbers are usually not appropriate for currency or fixed point decimal numbers as
+the underlying binary encoding can lead to errors in precision.  We provide floating point values
+only as a convenience for developers want to save development time and can live with approximated
+values in their use case.
+</p>
+</aside>
+
+
+
+#### Retrieve Pricing Policy
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+The API returns the current pricing policy for a merchant.  This API is valid for partner scoped API credentials
+and `merchantId` is a required parameter.  By default this API returns the currently in-force pricing policy for a merchant,
+but other inactive policies can be returned by providing the `id` parameter.
+
+Buy rates for interchange plus and fixed rate pricing are always returned, but only the pricing related to the 
+pricing model type (flat rate or interchange plus) are actually used in fee calculation.
+
+Each pricing level returns three values: `buyRate`, `current`, and `limit`.  The actual price the merchant will pay is 
+given in the `current` field.  The other values reflect the contract minimum (`buyRate`) and maximum (`limit`) range
+the partner can use when changing prices.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+}
+
+response = blockchyp.pricingPolicy(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Partner Statements
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+The API returns a list of partner residual statements.  By default, all statements are returned with the most recent
+statements listed first.  Optional date parameters (`startDate` and `endDate`) can filter statements to a specific date range.
+
+The list of statements returns basic information about statements like volume, transaction count, and commissions earned.
+
+Use the `id` returned with each statement summary with the *Partner Statement Detail* API to pull down full details.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+}
+
+response = blockchyp.partnerStatements(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Partner Statement Detail
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+The API returns detailed information about a specific partner statement.  Aggregate data is returned along with
+line item level data for each underlying merchant statement.
+
+Use the merchant invoice id with the *Merchant Statement Detail* API and the *Partner Commission Breakdown* API 
+to get the merchant statement and the card brand fee cost breakdown respectively.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+}
+
+response = blockchyp.partnerStatementDetail(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Merchant Invoices
+
+
+
+* **API Credential Types:** Partner or Merchant
+* **Required Role:** Partner API Access or Merchant API 
+
+The API returns a list of merchant statements and invoices.  By default, all invoices are returned with the most recent
+statements listed first.  Optional date parameters (`startDate` and `endDate`) can be used to filter statements by date
+range. 
+
+The `invoiceType` parameter can also be used to filter invoices by type.  Invoices could be conventional invoices, such
+as those generated when ordering terminals or gift cards, or invoices could be merchant statements.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+}
+
+response = blockchyp.merchantInvoices(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Merchant Invoice Detail
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+The API returns detailed information about a specific merchant statement or invoice.
+
+All line items are returned a topographically sorted tree modeling the nested line item structure of the 
+invoice.  Details about any payments posted against the invoice are returned.
+
+It the invoice is a merchant statement, details about every merchant deposit that occurred during the statement period
+are also returned.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+}
+
+response = blockchyp.merchantInvoiceDetail(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Partner Commission Breakdown
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+This API allows partners to pull down the low level data used to compute a partner commission for a specific merchant statement.
+
+The `statementId` is required and must be the id of a valid merchant invoice of type `statement`.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+}
+
+response = blockchyp.partnerCommissionBreakdown(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
 
 
 

data/lib/blockchyp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlockChyp
-  VERSION = '2.16.5'
+  VERSION = '2.17.3'
 end

data/lib/blockchyp.rb

@@ -264,6 +264,37 @@ module BlockChyp
       gateway_request('POST', '/api/tx-history', request)
     end
 
+    # Returns pricing policy for a merchant.
+    def pricing_policy(request)
+      gateway_request('POST', '/api/read-pricing-policy', request)
+    end
+
+    # Returns a list of partner statements.
+    def partner_statements(request)
+      gateway_request('POST', '/api/partner-statement-list', request)
+    end
+
+    # Returns detail for a single partner statement.
+    def partner_statement_detail(request)
+      gateway_request('POST', '/api/partner-statement-detail', request)
+    end
+
+    # Returns a list of merchant invoices.
+    def merchant_invoices(request)
+      gateway_request('POST', '/api/merchant-invoice-list', request)
+    end
+
+    # Returns detail for a single merchant-invoice statement.
+    def merchant_invoice_detail(request)
+      gateway_request('POST', '/api/merchant-invoice-detail', request)
+    end
+
+    # Returns low level details for how partner commissions were calculated
+    # for a specific merchant statement.
+    def partner_commission_breakdown(request)
+      gateway_request('POST', '/api/partner-commission-breakdown', request)
+    end
+
     # Returns profile information for a merchant.
     def merchant_profile(request)
       gateway_request('POST', '/api/public-merchant-profile', request)

data/test/merchant_invoice_detail_test.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class MerchantInvoiceDetailTest < TestCase
+    def test_merchant_invoice_detail
+
+      puts "Running test_merchant_invoice_detail..."
+
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
+
+
+      # Set request parameters
+      request = {
+        test: true
+      }
+
+      response = blockchyp.merchant_invoice_detail(request)
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

data/test/merchant_invoices_test.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class MerchantInvoicesTest < TestCase
+    def test_merchant_invoices
+
+      puts "Running test_merchant_invoices..."
+
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
+
+
+      # Set request parameters
+      request = {
+        test: true
+      }
+
+      response = blockchyp.merchant_invoices(request)
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

data/test/partner_commission_breakdown_test.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class PartnerCommissionBreakdownTest < TestCase
+    def test_partner_commission_breakdown
+
+      puts "Running test_partner_commission_breakdown..."
+
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
+
+
+      # Set request parameters
+      request = {
+        test: true
+      }
+
+      response = blockchyp.partner_commission_breakdown(request)
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

data/test/partner_statement_detail_test.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class PartnerStatementDetailTest < TestCase
+    def test_partner_statement_detail
+
+      puts "Running test_partner_statement_detail..."
+
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
+
+
+      # Set request parameters
+      request = {
+        test: true
+      }
+
+      response = blockchyp.partner_statement_detail(request)
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

data/test/partner_statements_test.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class PartnerStatementsTest < TestCase
+    def test_partner_statements
+
+      puts "Running test_partner_statements..."
+
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
+
+
+      # Set request parameters
+      request = {
+        test: true
+      }
+
+      response = blockchyp.partner_statements(request)
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

data/test/pricing_policy_test.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class PricingPolicyTest < TestCase
+    def test_pricing_policy
+
+      puts "Running test_pricing_policy..."
+
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
+
+
+      # Set request parameters
+      request = {
+        test: true,
+        merchantId: '<MERCHANT ID>'
+      }
+
+      response = blockchyp.pricing_policy(request)
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blockchyp
 version: !ruby/object:Gem::Version
-  version: 2.16.5
+  version: 2.17.3
 platform: ruby
 authors:
 - BlockChyp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-30 00:00:00.000000000 Z
+date: 2023-10-31 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -51,6 +51,8 @@ files:
 - test/media_asset_test.rb
 - test/media_test.rb
 - test/media_upload_test.rb
+- test/merchant_invoice_detail_test.rb
+- test/merchant_invoices_test.rb
 - test/merchant_platforms_test.rb
 - test/merchant_profile_test.rb
 - test/merchant_users_test.rb
@@ -59,7 +61,11 @@ files:
 - test/pan_enroll_test.rb
 - test/pan_preauth_test.rb
 - test/partial_refund_test.rb
+- test/partner_commission_breakdown_test.rb
+- test/partner_statement_detail_test.rb
+- test/partner_statements_test.rb
 - test/payment_link_status_test.rb
+- test/pricing_policy_test.rb
 - test/resend_payment_link_test.rb
 - test/search_customer_test.rb
 - test/send_payment_link_test.rb