blockchyp 2.15.23 → 2.15.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 033d4cc28f77b761ddc63a0a1e35c81a9fd580065eef354ad32e8d482928ad88
-  data.tar.gz: f3ff8e38bb0ec639e682ddf09cdb6294dd391cf9b588da81df989a1070dfae50
+  metadata.gz: 2790b1798c7d64d41af7489dfd7b894f866301be2ef737d8e0258b5ab2511cd4
+  data.tar.gz: 473b3a257d984c8fcd77cc29b710753a3643f7e15e906fe1458f4d139a801671
 SHA512:
-  metadata.gz: 7d267d55f9705b836487e66f2cc6eea09cbedda227c80b7763d9a5c270be859d94496bda44be218465970fe4af3a5c76b4198e12d82ac62bbf6d4016a7255bcb
-  data.tar.gz: eab4252071f20f9e5c134fc2b3d51e4f3d4d71f0b13b8707ab85a28947bcd7f96ecdd909346d14228d5ff7b2b5178b780b7a42762495218696278af70bc6d1c3
+  metadata.gz: aa9da544a25bba2460dd73ec469fbbfdc832cd4a6a6d95d395fa485888a201c9375e3f38fb9e418b1108ba09d12bf92deb812984fc180f04aa78be83c956898f
+  data.tar.gz: 6d06215d3a5a7e0e3f434a0f9ce97c5e4fb6c4d29b299d6ae7186fe245a4797f5b5d1ca26b0a3a85a1dfbbce45a35c34c74b6f8a6a5859313d5aa8dd4f586470

data/README.md

@@ -705,6 +705,8 @@ display additional UI widgets that allowing customers to switch to a crypto paym
 Add the `enroll` flag to a send link request to enroll the payment method
 in the token vault.
 
+Add the `enrollOnly` flag to enroll the payment method in the token vault without any immediate payment taking place. The payment link will ask the user for their payment information and inform them that they will not be charged immediately, but that their payment may be used for future transactions.
+
 **Cashier Facing Card Entry**
 
 BlockChyp can be used to generate internal/cashier facing card entry pages as well.  This is
@@ -825,6 +827,42 @@ response = blockchyp.cancelPaymentLink(request)
 puts "Response: #{response.inspect}"
 
 
+```
+
+#### Payment Link Status
+
+
+
+* **API Credential Types:** Merchant
+* **Required Role:** Payment API Access
+
+This API allows you to check on the status of a payment link, including transaction data
+and the full history of attempted transactions.
+
+
+
+
+```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 = {
+  linkCode: response[:linkCode]
+}
+
+response = blockchyp.paymentLinkStatus(request)
+
+puts "Response: #{response.inspect}"
+
+
 ```
 
 #### Transaction Status
@@ -1617,7 +1655,7 @@ puts "Response: #{response.inspect}"
 * **API Credential Types:** Merchant
 * **Required Role:** Payment API Access
 
-This API Pprompts the customer to answer a yes or no question.
+This API prompts the customer to answer a yes or no question.
 
 You can specify the question or prompt with the `prompt` parameter and
 the response is returned in the `response` field.

data/lib/blockchyp/version.rb

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

data/lib/blockchyp.rb

@@ -214,6 +214,11 @@ module BlockChyp
       gateway_request('POST', '/api/cancel-payment-link', request)
     end
 
+    # Retrieves the status of a payment link.
+    def payment_link_status(request)
+      gateway_request('POST', '/api/payment-link-status', request)
+    end
+
     # Retrieves the current status of a transaction.
     def transaction_status(request)
       gateway_request('POST', '/api/tx-status', request)

data/test/payment_link_status_test.rb

@@ -0,0 +1,72 @@
+# 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 PaymentLinkStatusTest < TestCase
+    def test_payment_link_status
+
+      puts "Running test_payment_link_status..."
+
+      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
+      setup_request = {
+        amount: '199.99',
+        description: 'Widget',
+        subject: 'Widget invoice',
+        transaction: {
+          subtotal: '195.00',
+          tax: '4.99',
+          total: '199.99',
+          items: [
+            {
+              description: 'Widget',
+              price: '195.00',
+              quantity: 1
+            }
+          ]
+        },
+        autoSend: true,
+        customer: {
+          customerRef: 'Customer reference string',
+          firstName: 'FirstName',
+          lastName: 'LastName',
+          companyName: 'Company Name',
+          emailAddress: 'notifications@blockchypteam.m8r.co',
+          smsNumber: '(123) 123-1231'
+        }
+      }
+      response = blockchyp.send_payment_link(setup_request)
+
+      # Set request parameters
+      request = {
+        transactionRef: response[:transactionRef]
+      }
+
+      response = blockchyp.payment_link_status(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.15.23
+  version: 2.15.25
 platform: ruby
 authors:
 - BlockChyp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-26 00:00:00.000000000 Z
+date: 2023-08-04 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -59,6 +59,7 @@ files:
 - test/pan_enroll_test.rb
 - test/pan_preauth_test.rb
 - test/partial_refund_test.rb
+- test/payment_link_status_test.rb
 - test/search_customer_test.rb
 - test/send_payment_link_test.rb
 - test/simple_batch_close_test.rb