blockchyp 2.19.0 → 2.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1ceaeac160aebac1400a60f940b7127680c0e6ee4be91c90fcbadbbaf94062e
-  data.tar.gz: d4d18670b1acb71f333571129fa074c0c80c717b46a0819ad77db0b8afe04756
+  metadata.gz: 36092c3724e15a799bd6818501835b3341dbab60be85a2197e32a66aae92bad5
+  data.tar.gz: 3e6f99e973a25da54e2b37cb6c04125848a79dac68267c29172cbd728fc78a5d
 SHA512:
-  metadata.gz: 8798686d3b0f23f7d7374b6721fdc1e095e00a5ce633397e8535553be607916966bf3a507a412486c27a3ca7bc9349e0171f5f45a0e656febd72e9e1e2ff68c6
-  data.tar.gz: 2c3fc65f7062be068e4308480c85eccb29e755be1ca0d0625e87047ab5b8763a4855e7392196ddf5c4a4cf6edcd393825639addcf57f4e3091bbd836b427b5ff
+  metadata.gz: efa1ee361c3da27538772284e2e151dc775febf44fff29b62a60ecb3586b292d59670dd7da1eb09faee44b2b9950c37a146df8e3e2087a2e1f70c91f2d116b10
+  data.tar.gz: 742ccc940a4138d6306f1f034535b9975fb99def600d52795eb626b261fe928ae1d46676f5f654b51c2666103079b513b65239aca5648b8e807d4f5435ab6835

data/README.md

@@ -396,6 +396,61 @@ response = blockchyp.void(request)
 puts "Response: #{response.inspect}"
 
 
+```
+
+#### Card Metadata
+
+
+
+* **API Credential Types:** Merchant
+* **Required Role:** Payment API Access
+
+This API allows you to retrieve card metadata.
+
+Card metadata requests can use a payment terminal to retrieve metadata or
+use a previously enrolled payment token.
+
+**Terminal Transactions**
+
+For terminal transactions, make sure you pass in the terminal name using the `terminalName` property.
+
+**Token Transactions**
+
+If you have a payment token, omit the `terminalName` property and pass in the token with the `token`
+property instead.
+
+**Card Numbers and Mag Stripes**
+
+You can also pass in PANs and Mag Stripes, but you probably shouldn't, as this will
+put you in PCI scope and the most common vector for POS breaches is keylogging.
+If you use terminals for manual card entry, you'll bypass any keyloggers that
+might be maliciously running on the point-of-sale system.
+
+
+
+
+```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 = {
+  test: true,
+  terminalName: 'Test Terminal'
+}
+
+response = blockchyp.cardMetadata(request)
+
+puts "Response: #{response.inspect}"
+
+
 ```
 
 #### Time Out Reversal
@@ -4279,6 +4334,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
+  merchantId: '<MERCHANT ID>'
 }
 
 response = blockchyp.merchantCredentialGeneration(request)
@@ -4288,6 +4344,53 @@ puts "Response: #{response.inspect}"
 
 ```
 
+#### Submit Application
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** INVITE MERCHANT
+
+This is a partner level API that can be used to submit applications to add new merchant accounts. The application requires a significant amount of detailed information about the merchant and their business. Rather than providing an exhaustive list of required fields, we recommend submitting as much information as possible in your initial request. 
+
+If any required fields are missing or if there are any validation errors, the API will return specific error messages indicating which fields need to be addressed. Simply review these validation errors, fill in the missing information or correct any errors, and resubmit the application.
+
+Key areas of information include:
+- Business details (name, type, tax information)
+- Contact information
+- Address information (physical and mailing)
+- Owner details
+- Bank account information
+- Transaction volume estimates
+- Operational settings (timezone, batch close time, etc.)
+
+**Note:** Some fields may be conditionally required based on the values of other fields. The validation process will guide you through ensuring all necessary information is provided.
+
+
+
+
+```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.submitApplication(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
 
 
 

data/lib/blockchyp/version.rb

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

data/lib/blockchyp.rb

@@ -98,6 +98,11 @@ module BlockChyp
       route_terminal_request('POST', '/api/enroll', '/api/enroll', request)
     end
 
+    # Retrieves card metadata.
+    def card_metadata(request)
+      route_terminal_request('POST', '/api/card-metadata', '/api/card-metadata', request)
+    end
+
     # Activates or recharges a gift card.
     def gift_activate(request)
       route_terminal_request('POST', '/api/gift-activate', '/api/gift-activate', request)
@@ -331,6 +336,11 @@ module BlockChyp
       dashboard_request('POST', '/api/generate-merchant-creds', request)
     end
 
+    # Submits and application to add a new merchant account.
+    def submit_application(request)
+      dashboard_request('POST', '/api/submit-application', request)
+    end
+
     # Adds a test merchant account.
     def get_merchants(request)
       dashboard_request('POST', '/api/get-merchants', request)

data/test/submit_application_test.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+# Copyright 2019-2024 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 SubmitApplicationTest < TestCase
+    def test_submit_application
+
+      puts "Running test_submit_application..."
+
+      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]
+
+
+      profile = config[:profiles][:partner]
+      blockchyp = BlockChyp.new(
+        profile[:apiKey],
+        profile[:bearerToken],
+        profile[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
+      # Set request parameters
+      request = {
+        test: true,
+        inviteCode: 'asdf',
+        dbaName: 'BlockChyp',
+        corporateName: 'BlockChyp Inc.',
+        webSite: 'https://www.blockchyp.com',
+        taxIdNumber: '123456789',
+        entityType: 'CORPORATION',
+        stateOfIncorporation: 'UT',
+        merchantType: 'RETAIL',
+        businessDescription: 'Payment processing solutions',
+        yearsInBusiness: '5',
+        businessPhoneNumber: '5555551234',
+        physicalAddress: {
+          address1: '355 S 520 W',
+          city: 'Lindon',
+          stateOrProvince: 'UT',
+          postalCode: '84042',
+          countryCode: 'US'
+        },
+        mailingAddress: {
+          address1: '355 S 520 W',
+          city: 'Lindon',
+          stateOrProvince: 'UT',
+          postalCode: '84042',
+          countryCode: 'US'
+        },
+        contactFirstName: 'John',
+        contactLastName: 'Doe',
+        contactPhoneNumber: '5555555678',
+        contactEmail: 'john.doe@example.com',
+        contactTitle: 'CEO',
+        contactTaxIdNumber: '987654321',
+        contactDOB: '1980-01-01',
+        contactDlNumber: 'D1234567',
+        contactDlStateOrProvince: 'NY',
+        contactDlExpiration: '2025-12-31',
+        contactHomeAddress: {
+          address1: '355 S 520 W',
+          city: 'Lindon',
+          stateOrProvince: 'UT',
+          postalCode: '84042',
+          countryCode: 'US'
+        },
+        contactRole: 'OWNER',
+        owners: [
+          {
+            firstName: 'John',
+            lastName: 'Doe',
+            jobTitle: 'CEO',
+            taxIdNumber: '876543210',
+            phoneNumber: '5555559876',
+            dob: '1981-02-02',
+            ownership: '50',
+            email: 'john.doe@example.com',
+            dlNumber: 'D7654321',
+            dlStateOrProvince: 'UT',
+            dlExpiration: '2024-12-31',
+            address: {
+              address1: '355 S 520 W',
+              city: 'Lindon',
+              stateOrProvince: 'UT',
+              postalCode: '84042',
+              countryCode: 'US'
+            }
+          }
+        ],
+        manualAccount: {
+          name: 'Business Checking',
+          bank: 'Test Bank',
+          accountHolderName: 'BlockChyp Inc.',
+          routingNumber: '124001545',
+          accountNumber: '987654321'
+        },
+        averageTransaction: '100.00',
+        highTransaction: '1000.00',
+        averageMonth: '10000.00',
+        highMonth: '20000.00',
+        refundPolicy: '30_DAYS',
+        refundDays: '30',
+        timeZone: 'America/Denver',
+        batchCloseTime: '23:59',
+        multipleLocations: 'false',
+        ebtRequested: 'false',
+        ecommerce: 'true',
+        cardPresentPercentage: '70',
+        phoneOrderPercentage: '10',
+        ecomPercentage: '20',
+        signerName: 'John Doe'
+      }
+
+      response = blockchyp.submit_application(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.19.0
+  version: 2.20.1
 platform: ruby
 authors:
 - BlockChyp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -83,6 +83,7 @@ files:
 - test/simple_void_test.rb
 - test/slide_show_test.rb
 - test/slide_shows_test.rb
+- test/submit_application_test.rb
 - test/survey_question_test.rb
 - test/survey_questions_test.rb
 - test/survey_results_test.rb