blockchyp 2.3.5 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ca711b2e47c0391a4d2bae6df5f33eb9585fca0aec4121aa2a26bf6a96a2516
-  data.tar.gz: e63cfc05d92201d6ed4d30f6f0e7f83aa5224b8fbc54b34b8845e427bcef52f3
+  metadata.gz: d037bf68ebcb4488700ff0c2fbeee974d8c32c120ccb050b0c1864ba330a5760
+  data.tar.gz: b61fb9984e14e6d29be19fde7544624cafb49e7188d79f08a15b3303694e1b2c
 SHA512:
-  metadata.gz: 95113934892b77a450f0b9b0c69a4cd61721fd4cdf4286b73f99c9420ffeab10c7cdc892af18901b550731fa2a5579c76b28369031edac105075d00b7421fc25
-  data.tar.gz: c899ac8ef7ecf482d9e99102a4d8af54845d8f63d11522fc73ec9b0c1c3e17cb80a244d71f1b075ec5cdca42e6274bc3d957a6a4ea47681b9438d741b14077e7
+  metadata.gz: b38ac6a4f98c70146374a6c39c2dffc1294001c4fe6f5ab64487cefcf4b22c9172a88e3ce2e015348066537862d91f04cc7b7c19e8dec4643f5dc0449603d53c
+  data.tar.gz: f65fb7d83545ddd95edb1c5cfd966689eb7f7cdfe7498ffb8f79b4880e5500ad27d59d4139eea7a2f3cdffdeee7c45264376809e9d2fb5d501418125f39b9823

data/README.md

@@ -86,7 +86,7 @@ If you get a positive response, you've successfully verified all of the followin
 
 * The terminal is online.
 * There is a valid route to the terminal.
-* The API Credential are valid.
+* The API Credentials are valid.
 
 
 
@@ -104,7 +104,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "terminalName": 'Test Terminal'
+  terminalName: 'Test Terminal'
 }
 
 response = blockchyp.ping(request)
@@ -166,9 +166,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "amount": '55.00'
+  test: true,
+  terminalName: 'Test Terminal',
+  amount: '55.00'
 }
 
 response = blockchyp.charge(request)
@@ -230,9 +230,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "amount": '27.00'
+  test: true,
+  terminalName: 'Test Terminal',
+  amount: '27.00'
 }
 
 response = blockchyp.preauth(request)
@@ -270,8 +270,8 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "transactionId": '<PREAUTH TRANSACTION ID>'
+  test: true,
+  transactionId: '<PREAUTH TRANSACTION ID>'
 }
 
 response = blockchyp.capture(request)
@@ -346,10 +346,10 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "transactionId": '<PREVIOUS TRANSACTION ID>',
+  transactionId: '<PREVIOUS TRANSACTION ID>',
 
   # Optional amount for partial refunds.
-  "amount": '5.00'
+  amount: '5.00'
 }
 
 response = blockchyp.refund(request)
@@ -394,8 +394,8 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal'
+  test: true,
+  terminalName: 'Test Terminal'
 }
 
 response = blockchyp.enroll(request)
@@ -431,8 +431,8 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "transactionId": '<PREVIOUS TRANSACTION ID>'
+  test: true,
+  transactionId: '<PREVIOUS TRANSACTION ID>'
 }
 
 response = blockchyp.void(request)
@@ -479,7 +479,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "transactionRef": '<LAST TRANSACTION REF>'
+  transactionRef: '<LAST TRANSACTION REF>'
 }
 
 response = blockchyp.reverse(request)
@@ -559,9 +559,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "amount": '50.00'
+  test: true,
+  terminalName: 'Test Terminal',
+  amount: '50.00'
 }
 
 response = blockchyp.giftActivate(request)
@@ -588,7 +588,7 @@ briefly on the terminal screen and the API response will include the gift card's
 All EBT transactions require a PIN, so in order to check an EBT card balance,
 you need to pass in the `ebt` flag just like you would for a normal EBT
 charge transaction.  The customer will be prompted to swipe their card and
-enter a PIN code.  If everything checks out, the remaining balance on the card will be displayed on terminal for the customer and returned in the API.
+enter a PIN code.  If everything checks out, the remaining balance on the card will be displayed on the terminal for the customer and returned in the API.
 
 **Testing Gift Card Balance Checks**
 
@@ -617,9 +617,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "cardType": CardType::EBT
+  test: true,
+  terminalName: 'Test Terminal',
+  cardType: CardType::EBT
 }
 
 response = blockchyp.balance(request)
@@ -656,7 +656,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true
+  test: true
 }
 
 response = blockchyp.closeBatch(request)
@@ -717,6 +717,11 @@ a safeguard to prevent real emails from going out when you may not expect it.
 If you want BlockChyp to send the email for you, just add the `autoSend` flag with
 all requests.
 
+**Tokenization**
+
+Add the `enroll` flag to a send link request to enroll the payment method
+in the token vault.
+
 **Cashier Facing Card Entry**
 
 BlockChyp can be used to generate internal/cashier facing card entry pages as well.  This is
@@ -744,7 +749,7 @@ same format as all BlockChyp charge and preauth transaction responses.
 
 **Status Polling**
 
-If real time callbacks aren't practical or necesary in your environment, you can
+If real time callbacks aren't practical or necessary in your environment, you can
 always use the Transaction Status API described below.
 
 A common use case for the send link API with status polling is curbside pickup.
@@ -768,29 +773,29 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "amount": '199.99',
-  "description": 'Widget',
-  "subject": 'Widget invoice',
-  "transaction": {
-    "subtotal": '195.00',
-    "tax": '4.99',
-    "total": '199.99',
-    "items": [
+  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
+        description: 'Widget',
+        price: '195.00',
+        quantity: 1
       }
     ]
   },
-  "autoSend": true,
-  "customer": {
-    "customerRef": 'Customer reference string',
-    "firstName": 'FirstName',
-    "lastName": 'LastName',
-    "companyName": 'Company Name',
-    "emailAddress": 'support@blockchyp.com',
-    "smsNumber": '(123) 123-1231'
+  autoSend: true,
+  customer: {
+    customerRef: 'Customer reference string',
+    firstName: 'FirstName',
+    lastName: 'LastName',
+    companyName: 'Company Name',
+    emailAddress: 'support@blockchyp.com',
+    smsNumber: '(123) 123-1231'
   }
 }
 
@@ -828,7 +833,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "transactionId": 'ID of transaction to retrieve'
+  transactionId: 'ID of transaction to retrieve'
 }
 
 response = blockchyp.transactionStatus(request)
@@ -862,8 +867,8 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal'
+  test: true,
+  terminalName: 'Test Terminal'
 }
 
 response = blockchyp.clear(request)
@@ -904,7 +909,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "terminalName": 'Test Terminal'
+  terminalName: 'Test Terminal'
 }
 
 response = blockchyp.terminalStatus(request)
@@ -972,27 +977,27 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
+  test: true,
+  terminalName: 'Test Terminal',
 
   # Alias for a Terms and Conditions template configured in the BlockChyp
   # dashboard.
-  "tcAlias": 'hippa',
+  tcAlias: 'hippa',
 
   # Name of the contract or document if not using an alias.
-  "tcName": 'HIPPA Disclosure',
+  tcName: 'HIPPA Disclosure',
 
   # Full text of the contract or disclosure if not using an alias.
-  "tcContent": 'Full contract text',
+  tcContent: 'Full contract text',
 
   # File format for the signature image.
-  "sigFormat": SignatureFormat::PNG,
+  sigFormat: SignatureFormat::PNG,
 
   # Width of the signature image in pixels.
-  "sigWidth": 200,
+  sigWidth: 200,
 
   # Whether or not a signature is required. Defaults to true.
-  "sigRequired": true
+  sigRequired: true
 }
 
 response = blockchyp.termsAndConditions(request)
@@ -1041,13 +1046,13 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "terminalName": 'Test Terminal',
+  terminalName: 'Test Terminal',
 
   # File format for the signature image.
-  "sigFormat": SignatureFormat::PNG,
+  sigFormat: SignatureFormat::PNG,
 
   # Width of the signature image in pixels.
-  "sigWidth": 200
+  sigWidth: 200
 }
 
 response = blockchyp.captureSignature(request)
@@ -1097,22 +1102,22 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "transaction": {
-    "subtotal": '60.00',
-    "tax": '5.00',
-    "total": '65.00',
-    "items": [
+  test: true,
+  terminalName: 'Test Terminal',
+  transaction: {
+    subtotal: '60.00',
+    tax: '5.00',
+    total: '65.00',
+    items: [
       {
-        "description": 'Leki Trekking Poles',
-        "price": '35.00',
-        "quantity": 2,
-        "extended": '70.00',
-        "discounts": [
+        description: 'Leki Trekking Poles',
+        price: '35.00',
+        quantity: 2,
+        extended: '70.00',
+        discounts: [
           {
-            "description": 'memberDiscount',
-            "amount": '10.00'
+            description: 'memberDiscount',
+            amount: '10.00'
           }
         ]
       }
@@ -1175,22 +1180,22 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "transaction": {
-    "subtotal": '60.00',
-    "tax": '5.00',
-    "total": '65.00',
-    "items": [
+  test: true,
+  terminalName: 'Test Terminal',
+  transaction: {
+    subtotal: '60.00',
+    tax: '5.00',
+    total: '65.00',
+    items: [
       {
-        "description": 'Leki Trekking Poles',
-        "price": '35.00',
-        "quantity": 2,
-        "extended": '70.00',
-        "discounts": [
+        description: 'Leki Trekking Poles',
+        price: '35.00',
+        quantity: 2,
+        extended: '70.00',
+        discounts: [
           {
-            "description": 'memberDiscount',
-            "amount": '10.00'
+            description: 'memberDiscount',
+            amount: '10.00'
           }
         ]
       }
@@ -1229,9 +1234,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "message": 'Thank you for your business.'
+  test: true,
+  terminalName: 'Test Terminal',
+  message: 'Thank you for your business.'
 }
 
 response = blockchyp.message(request)
@@ -1274,11 +1279,11 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "prompt": 'Would you like to become a member?',
-  "yesCaption": 'Yes',
-  "noCaption": 'No'
+  test: true,
+  terminalName: 'Test Terminal',
+  prompt: 'Would you like to become a member?',
+  yesCaption: 'Yes',
+  noCaption: 'No'
 }
 
 response = blockchyp.booleanPrompt(request)
@@ -1330,12 +1335,12 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
+  test: true,
+  terminalName: 'Test Terminal',
 
   # Type of prompt. Can be 'email', 'phone', 'customer-number', or
   # 'rewards-number'.
-  "promptType": PromptType::EMAIL
+  promptType: PromptType::EMAIL
 }
 
 response = blockchyp.textPrompt(request)
@@ -1352,7 +1357,7 @@ puts "Response: #{response.inspect}"
 Adds or updates a customer record.
 
 If you pass in customer information including `firstName`, `lastName`, `email`,
-`email`, or `sms` without any Customer ID or Customer Ref, a new record will
+or `sms` without any Customer ID or Customer Ref, a new record will
 be created.
 
 If you pass in `customerRef` and `customerId`, the customer record will be updated
@@ -1389,14 +1394,14 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "customer": {
-    "id": 'ID of the customer to update',
-    "customerRef": 'Customer reference string',
-    "firstName": 'FirstName',
-    "lastName": 'LastName',
-    "companyName": 'Company Name',
-    "emailAddress": 'support@blockchyp.com',
-    "smsNumber": '(123) 123-1231'
+  customer: {
+    id: 'ID of the customer to update',
+    customerRef: 'Customer reference string',
+    firstName: 'FirstName',
+    lastName: 'LastName',
+    companyName: 'Company Name',
+    emailAddress: 'support@blockchyp.com',
+    smsNumber: '(123) 123-1231'
   }
 }
 
@@ -1432,7 +1437,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "customerId": 'ID of the customer to retrieve'
+  customerId: 'ID of the customer to retrieve'
 }
 
 response = blockchyp.customer(request)
@@ -1467,7 +1472,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "query": '(123) 123-1234'
+  query: '(123) 123-1234'
 }
 
 response = blockchyp.customerSearch(request)
@@ -1503,9 +1508,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "amount": '100.00',
-  "cashDiscount": true,
-  "surcharge": true
+  amount: '100.00',
+  cashDiscount: true,
+  surcharge: true
 }
 
 response = blockchyp.cashDiscount(request)
@@ -1557,8 +1562,8 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "maxResults": 250,
-  "startIndex": 1
+  maxResults: 250,
+  startIndex: 1
 }
 
 response = blockchyp.batchHistory(request)
@@ -1596,7 +1601,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "batchId": 'BATCHID'
+  batchId: 'BATCHID'
 }
 
 response = blockchyp.batchDetails(request)
@@ -1664,7 +1669,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "maxResults": 10
+  maxResults: 10
 }
 
 response = blockchyp.transactionHistory(request)
@@ -1672,6 +1677,39 @@ response = blockchyp.transactionHistory(request)
 puts "Response: #{response.inspect}"
 
 
+```
+
+#### Merchant Profile
+
+
+
+Returns detailed metadata about the merchant's configuraton, including
+basic identity information, terminal settings, store and forward settings,
+and bank account information for merchants that support split settlement.
+
+
+
+
+```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.merchantProfile(request)
+
+puts "Response: #{response.inspect}"
+
+
 ```
 
 ## Running Integration Tests