blockchyp 2.3.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9b0bc43922617adfcb4e8f0d20eef4d54a5dac3aee17efd246aaa6789caeac7
-  data.tar.gz: c21e621def8bc145fe223771f205912ea20a0596ade43bf04f1a9c462ba476c7
+  metadata.gz: 6d481215ba0fe7d5cee061463d93274a0d8f088fdec08a0a6cb8236c47366917
+  data.tar.gz: fab48021f9c4d0afd995a2027d65125d13e7827eb427389729292be5cee2083c
 SHA512:
-  metadata.gz: b7e80346fa5aef7adacb2d2328cf4639bd937c235a750ab835dfa16a576c26223df9c5ca7fdfec9b1b6f49ab36b13898240cc07660aff3e7b7184e7181e11670
-  data.tar.gz: 5855fa07b214ba2eee7327c93af6eaefd73b2781e1a584658637ba63c89eb12a8af583a6226490fff027a5ea62eee900ba9de41c604f1c413c752b607dbcc699
+  metadata.gz: 78ea652f19b13953b7c6b146416eaff3120709756e4231dd70c656069d08bc1ac4dd18969cd2bfc83dcd82d0b5d5a18efea3290ff7ac9b817f7b6fec4b87c33e
+  data.tar.gz: 7d9d412d62e19e33ba6f1b057ca6f21b2ff3c3d74c6ef1213fbc0868a8bd904390d9214d49e8b518a26fdaf4b7e2e730fea9fddc945b284097834204645bd477

data/README.md

@@ -98,9 +98,21 @@ You can also view a number of long form demos and learn more about us on our [Yo
 You don't want to read words. You want examples. Here's a quick rundown of the
 stuff you can do with the BlockChyp Ruby SDK and a few basic examples.
 
-#### Charge
+#### Terminal Ping
+
+
+This simple test transaction helps ensure you have good communication with a payment terminal and is usually the first one you'll run in development.
+
+It tests communication with the terminal and returns a positive response if everything
+is okay.  It works the same way in local or cloud relay mode.
+
+If you get a positive response, you've successfully verified all of the following:
+
+* The terminal is online.
+* There is a valid route to the terminal.
+* The API Credential are valid.
+
 
-Executes a standard direct preauth and capture.
 
 
 ```ruby
@@ -116,21 +128,53 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "amount": '55.00'
+  "terminalName": 'Test Terminal'
 }
 
-response = blockchyp.charge(request)
+response = blockchyp.ping(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Preauthorization
+#### Charge
+
+
+Our most popular transaction executes a standard authorization and capture.
+This is the most basic of
+basic payment transactions, typically used in conventional retail.
+
+Charge transactions can use a payment terminal to capture a payment 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.  This will
+put you in PCI scope and the most common vector for POS breaches is key logging.
+If you use terminals for manual card entry, you'll bypass any key loggers that
+might be maliciously running on the point-of-sale system.
+
+**Common Variations**
+
+* **Gift Card Redemption**:  There's no special API for gift card redemption in BlockChyp.  Just execute a plain charge transaction and if the customer happens to swipe a gift card, our terminals will identify the gift card and run a gift card redemption.  Also note that if for some reason the gift card's original purchase transaction is associated with fraud or a chargeback, the transaction will be rejected.
+* **EBT**: Set the `ebt` flag to process an EBT SNAP transaction.  Note that test EBT transactions alway assume a balance of $100.00, so test EBT transactions over that amount may be declined.
+* **Cash Back**: To enable cash back for debit transactions, set the `cashBack` flag.  If the card presented isn't a debit card, the `cashBack` flag will be ignored.
+* **Manual Card Entry**: Set the `manual` flag to enable manual card entry.  Good as a backup when chips and MSR's don't work or for more secure phone orders.  You can even combine the `manual` flag with the `ebt` flag for manual EBT card entry.
+* **Inline Tokenization**: You can enroll the payment method in the token vault inline with a charge transaction by setting the `enroll` flag.  You'll get a token back in the response.  You can even bind the token to a customer record if you also pass in customer data.
+* **Prompting for Tips**: Set the `promptForTips` flag if you'd like to prompt the customer for a tip before authorization.  Good for pay-at-the-table and other services related scenarios.
+* **Cash Discounting and Surcharging**:  The `surcharge` and `cashDiscount` flags can be used together to support cash discounting or surcharge problems. Consult the Cash Discount documentation for more details.
+
 
-Executes a preauthorization intended to be captured later.
 
 
 ```ruby
@@ -148,47 +192,53 @@ blockchyp = BlockChyp::BlockChyp.new(
 request = {
   "test": true,
   "terminalName": 'Test Terminal',
-  "amount": '27.00'
+  "amount": '55.00'
 }
 
-response = blockchyp.preauth(request)
+response = blockchyp.charge(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Terminal Ping
+#### Preauthorization
 
-Tests connectivity with a payment terminal.
 
+A preauthorization puts a hold on funds and must be captured later.  This is used
+in scenarios where the final transaction amount might change.  Examples would
+be fine dining where a tip adjustment is required prior to capture or hotels
 
-```ruby
-# frozen_string_literal: true
+Another use case for preauthorization is e-commerce.  Typically, an online order
+is preauthorized at the time of the order and then captured when the order ships.
 
-require 'blockchyp'
+Preauthorizations can use a payment terminal to capture a payment or
+use a previously enrolled payment token.
 
-blockchyp = BlockChyp::BlockChyp.new(
-  ENV['BC_API_KEY'],
-  ENV['BC_BEARER_TOKEN'],
-  ENV['BC_SIGNING_KEY']
-)
+**Terminal Transactions**
 
-# Set request parameters
-request = {
-  "terminalName": 'Test Terminal'
-}
+For terminal transactions, make sure you pass in the terminal name using the `terminalName` property.
 
-response = blockchyp.ping(request)
+**Token Transactions**
 
-puts "Response: #{response.inspect}"
+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.  This will
+put you in PCI scope and the most common vector for POS breaches is key logging.
+If you use terminals for manual card entry, you'll bypass any key loggers that
+might be maliciously running on the point-of-sale system.
+
+**Common Variations**
+
+* **Manual Card Entry**: Set the `manual` flag to enable manual card entry.  Good as a backup when chips and MSR's don't work or for more secure phone orders.  You can even combine the `manual` flag with the `ebt` flag for manual EBT card entry.
+* **Inline Tokenization**: You can enroll the payment method in the token vault in line with a charge transaction by setting the `enroll` flag.  You'll get a token back in the response.  You can even bind the token to a customer record if you also pass in customer data.
+* **Prompting for Tips**: Set the `promptForTips` flag if you'd like to prompt the customer for a tip before authorization.  You can prompt for tips as part of a preauthorization, although it's not a very common approach.
+* **Cash Discounting and Surcharging**:  The `surcharge` and `cashDiscount` flags can be used together to support cash discounting or surcharge problems. Consult the Cash Discount documentation for more details.
 
-#### Balance
 
-Checks the remaining balance on a payment method.
 
 
 ```ruby
@@ -206,19 +256,29 @@ blockchyp = BlockChyp::BlockChyp.new(
 request = {
   "test": true,
   "terminalName": 'Test Terminal',
-  "cardType": CardType::EBT
+  "amount": '27.00'
 }
 
-response = blockchyp.balance(request)
+response = blockchyp.preauth(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Terminal Clear
+#### Capture Preauthorization
+
+
+This API allows you to capture a previously approved preauthorization.
+
+You'll need to make sure you pass in the Transaction ID returned by the original preauth transaction so we know which transaction we're capturing.  If you want to capture the transaction for the
+exact amount of the preauth, the Transaction ID is all you need to pass in.
+
+You can adjust the total if you need to by passing in a new `amount`.  We
+also recommend you pass in updated amounts for `tax` and `tip` as it can
+reduce your interchange fees in some cases. (Level II Processing, for example.)
+
 
-Clears the line item display and any in progress transaction.
 
 
 ```ruby
@@ -235,69 +295,66 @@ blockchyp = BlockChyp::BlockChyp.new(
 # Set request parameters
 request = {
   "test": true,
-  "terminalName": 'Test Terminal'
+  "transactionId": '<PREAUTH TRANSACTION ID>'
 }
 
-response = blockchyp.clear(request)
+response = blockchyp.capture(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Terms & Conditions Capture
+#### Refund
 
-Prompts the user to accept terms and conditions.
 
+It's not ideal, but sometimes customers want their money back.
 
-```ruby
-# frozen_string_literal: true
+Our refund API allows you to confront this unpleasant reality by executing refunds in a few different scenarios.
 
-require 'blockchyp'
+The most fraud resistent method is to execute refunds in the context of a previous transaction.  You should always keep track of the Transaction ID
+returned in a BlockChyp response.  To refund the full amount of the previous transaction, just pass in the original Transaction ID with the refund requests.
 
-blockchyp = BlockChyp::BlockChyp.new(
-  ENV['BC_API_KEY'],
-  ENV['BC_BEARER_TOKEN'],
-  ENV['BC_SIGNING_KEY']
-)
+**Partial Refunds**
 
-# Set request parameters
-request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
+For a partial refund, just passing an amount along with the Transaction ID.
+The only rule is that the amount has to be equal to or less than the original
+transaction.  You can even execute multiple partial refunds against the same
+original transaction as long as the total refunded amount doesn't exceed the original transaction.
 
-  # Alias for a Terms and Conditions template configured in the BlockChyp
-  # dashboard.
-  "tcAlias": 'hippa',
+**Tokenized Refunds**
 
-  # Name of the contract or document if not using an alias.
-  "tcName": 'HIPPA Disclosure',
+You can also use a token to execute a refund.  Just pass in a token instead
+of the Transaction ID along with the desired refund amount.
 
-  # Full text of the contract or disclosure if not using an alias.
-  "tcContent": 'Full contract text',
+**Free Range Refunds**
 
-  # File format for the signature image.
-  "sigFormat": SignatureFormat::PNG,
+When you execute a refund without referencing a previous transaction, we
+call this a *free range refund*.
 
-  # Width of the signature image in pixels.
-  "sigWidth": 200,
+We don't recommend it, but it is permitted.  Just pass in a
+Terminal Name and an amount.
 
-  # Whether or not a signature is required. Defaults to true.
-  "sigRequired": true
-}
+You can even execute a manual or keyed refund by passing the `manual` flag
+to a free range refund request.
 
-response = blockchyp.termsAndConditions(request)
+**Gift Card Refunds**
 
-puts "Response: #{response.inspect}"
+Gift card refunds are allowed in the context of a previous transaction, but
+free range gift card refunds are not allowed.  Use the gift card activation
+API if you need to add more funds to a gift card.
 
+**Store and Forward Support**
 
-```
+Refunds are not permitted when a terminal falls back to store and forward mode.
+
+**Auto Voids**
+
+If a refund referencing a previous transaction is executed for the full amount
+before the original transaction's batch is closed, the refund is automatically
+converted to a void.  This saves the merchant a little bit of money.
 
-#### Update Transaction Display
 
-Appends items to an existing transaction display.  Subtotal, Tax, and Total are
-overwritten by the request. Items with the same description are combined into
-groups.
 
 
 ```ruby
@@ -313,39 +370,40 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "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": 'memberDiscount',
-            "amount": '10.00'
-          }
-        ]
-      }
-    ]
-  }
+  "transactionId": '<PREVIOUS TRANSACTION ID>',
+
+  # Optional amount for partial refunds.
+  "amount": '5.00'
 }
 
-response = blockchyp.updateTransactionDisplay(request)
+response = blockchyp.refund(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### New Transaction Display
+#### Enroll
+
+
+This API allows you to tokenize and enroll a payment method in the token
+vault.  You can also pass in customer information and associate the
+payment method with a customer record.
+
+A token is returned in the response that can be used in subsequent charge,
+preauth, and refund transactions.
+
+**Gift Cards and EBT**
+
+Gift Cards and EBT cards cannot be tokenized.
+
+**E-Commerce Tokens**
+
+The tokens returned by the enroll API and the e-commerce web tokenizer
+are the same tokens and can be used interchangeably.
+
 
-Displays a new transaction on the terminal.
 
 
 ```ruby
@@ -362,38 +420,27 @@ blockchyp = BlockChyp::BlockChyp.new(
 # Set request parameters
 request = {
   "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": 'memberDiscount',
-            "amount": '10.00'
-          }
-        ]
-      }
-    ]
-  }
+  "terminalName": 'Test Terminal'
 }
 
-response = blockchyp.newTransactionDisplay(request)
+response = blockchyp.enroll(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Text Prompt
+#### Void
+
+
+
+Mistakes happen.  If a transaction is made by mistake, you can void it
+with this API.  All that's needed is to pass in a Transaction ID and execute
+the void before the original transaction's batch closes.
+
+Voids work with EBT and gift card transactions with no additional parameters.
+
 
-Asks the consumer a text based question.
 
 
 ```ruby
@@ -410,23 +457,38 @@ blockchyp = BlockChyp::BlockChyp.new(
 # Set request parameters
 request = {
   "test": true,
-  "terminalName": 'Test Terminal',
-
-  # Type of prompt. Can be 'email', 'phone', 'customer-number', or
-  # 'rewards-number'.
-  "promptType": PromptType::EMAIL
+  "transactionId": '<PREVIOUS TRANSACTION ID>'
 }
 
-response = blockchyp.textPrompt(request)
+response = blockchyp.void(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Boolean Prompt
+#### Time Out Reversal
+
+
+
+Payment transactions require a stable network to function correctly and
+no network is stable all the time.  Time out reversals are a great line
+of defense against accidentally double charging consumers when payments
+are retried during shaky network conditions.
+
+We highly recommend developers use this API whenever a charge, preauth, or refund transaction times out.  If you don't receive a definitive response
+from BlockChyp, you can't be certain about whether or not the transaction went through.
+
+A best practice in this situation is to send a time out reversal request.  Time out reversals check for a transaction and void it if it exists.
+
+The only caveat is that developers must use the `transactionRef` property (`txRef` for the CLI) when executing charge, preauth, and refund transactions.
+
+The reason for this requirement is that if a system never receives a definitive
+response for a transaction, the system would never have received the BlockChyp
+generated Transaction ID.  We have to fallback to transaction ref to identify
+a transaction.
+
 
-Asks the consumer a yes/no question.
 
 
 ```ruby
@@ -442,23 +504,70 @@ 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'
+  "transactionRef": '<LAST TRANSACTION REF>'
 }
 
-response = blockchyp.booleanPrompt(request)
+response = blockchyp.reverse(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Display Message
+#### Gift Card Activation
+
+
+This API can be used to activate or add value to BlockChyp gift cards.
+Just pass in the terminal name and the amount to add to the card.
+Once the customer swipes their card, the terminal will use keys
+on the mag stripe to add value to the card.
+
+You don't need to handle a new gift card or a gift card recharge any
+differently.  The terminal firmware will figure out what to do on its
+own and also returns the new balance for the gift card.
+
+This is the part of the system where BlockChyp's blockchain DNA comes
+closest to the surface.  The BlockChyp gift card system doesn't really
+use gift card numbers.  This means they can't be stolen.
+
+BlockChyp identifies cards with an elliptic curve public key instead.
+Gift card transactions are actually blocks signed with those keys.
+This means there are no shared secrets sent over the network with
+BlockChyp gift cards.
+To keep track of a BlockChyp gift card, hang on to the **public key** returned
+during gift card activation.  That's the gift card's elliptic curve public key.
+
+We sometimes print numbers on our gift cards, but these are actually
+decimal encoded hashes of a portion of the public key to make our gift
+cards seem *normal* to *normies*.  They can be used
+for balance checks and play a lookup role in online gift card
+authorization, but are of little use beyond that.
+
+**Voids and Reversals**
+
+Gift card activations can be voided and reversed just like any other
+BlockChyp transaction.  Use the Transaction ID or Transaction Ref
+to identify the gift activation transaction as you normally would for
+voiding or reversing a conventional payment transaction.
+
+**Importing Gift Cards**
+
+BlockChyp does have the ability to import gift card liability from
+conventional gift card platforms.  Unfortunately, BlockChyp does not
+support activating cards on third party systems, but you can import
+your outstanding gift cards and customerSearch can swipe them on the
+terminals just like BlockChyp's standard gift cards.
+
+No special coding is required to access this feature.  The gateway and
+terminal firmware handle everything for you.
+
+**Third Party Gift Card Networks**
+
+BlockChyp does not currently provide any native support for other gift card
+platforms beyond importing gift card liability.  We do have a white listing system however that be used support your own custom gift card implementations.  We have a security review
+process before we allow a BIN range to be white listed, so contact support@blockchyp.com if you need to white list a BIN range.
+
 
-Displays a short message on the terminal.
 
 
 ```ruby
@@ -476,51 +585,47 @@ blockchyp = BlockChyp::BlockChyp.new(
 request = {
   "test": true,
   "terminalName": 'Test Terminal',
-  "message": 'Thank you for your business.'
+  "amount": '50.00'
 }
 
-response = blockchyp.message(request)
+response = blockchyp.giftActivate(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Refund
+#### Balance
 
-Executes a refund.
 
 
-```ruby
-# frozen_string_literal: true
+Checks a gift or EBT card balance.
 
-require 'blockchyp'
+**Gift Card Balance Checks**
 
-blockchyp = BlockChyp::BlockChyp.new(
-  ENV['BC_API_KEY'],
-  ENV['BC_BEARER_TOKEN'],
-  ENV['BC_SIGNING_KEY']
-)
+For gift cards, just pass in a terminal name and the customer will be prompted
+to swipe a card on that terminal.  The remaining balance will be displayed
+briefly on the terminal screen and the API response will include the gift card's public key and the remaining balance.
 
-# Set request parameters
-request = {
-  "terminalName": 'Test Terminal',
-  "transactionId": '<PREVIOUS TRANSACTION ID>',
+**EBT Balance Checks**
 
-  # Optional amount for partial refunds.
-  "amount": '5.00'
-}
+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.
 
-response = blockchyp.refund(request)
+**Testing Gift Card Balance Checks**
 
-puts "Response: #{response.inspect}"
+Test gift card balance checks works no differently than live gift cards.  You
+must activate a test gift card first in order to test balance checks.  Test
+gift cards are real blockchain cards that live on our parallel test blockchain.
 
+**Testing EBT Gift Card Balance Checks**
 
-```
+All test EBT transactions assume a starting balance of $100.00.  As a result,
+test EBT balance checks always return a balance of $100.00.
 
-#### Enroll
 
-Adds a new payment method to the token vault.
 
 
 ```ruby
@@ -537,19 +642,29 @@ blockchyp = BlockChyp::BlockChyp.new(
 # Set request parameters
 request = {
   "test": true,
-  "terminalName": 'Test Terminal'
+  "terminalName": 'Test Terminal',
+  "cardType": CardType::EBT
 }
 
-response = blockchyp.enroll(request)
+response = blockchyp.balance(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Gift Card Activation
+#### Close Batch
+
+
+This API will close the merchant's batch, if it's currently open.
+
+By default, merchant batches will close automatically at 3 AM in their
+local time zone.  The automatic batch closure time can be changed
+in the Merchant Profile or disabled completely.
+
+If automatic batch closure is disabled, you'll need to use this API to
+close the batch manually.
 
-Activates or recharges a gift card.
 
 
 ```ruby
@@ -565,37 +680,100 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "amount": '50.00'
+  "test": true
 }
 
-response = blockchyp.giftActivate(request)
+response = blockchyp.closeBatch(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Time Out Reversal
+#### Send Payment Link
 
-Executes a manual time out reversal.
 
-We love time out reversals. Don't be afraid to use them whenever a request to a
-BlockChyp terminal times out. You have up to two minutes to reverse any
-transaction. The only caveat is that you must assign transactionRef values when
-you build the original request. Otherwise, we have no real way of knowing which
-transaction you're trying to reverse because we may not have assigned it an id
-yet. And if we did assign it an id, you wouldn't know what it is because your
-request to the terminal timed out before you got a response.
 
+This API allows you to send an invoice to a customer and capture payment
+via a BlockChyp hosted payment page.
 
-```ruby
-# frozen_string_literal: true
+If you set the `autoSend` flag, BlockChyp will send a basic invoice email
+to the customer for you that includes the payment link.  If you'd rather have
+more control over the look of the email message, you can omit the `autoSend`
+flag and send the customer email yourself.
 
-require 'blockchyp'
+There are a lot of optional parameters for this API, but at a minimum
+you'll need to pass in a total, customer name, and email address.
 
-blockchyp = BlockChyp::BlockChyp.new(
+**Customer Info**
+
+You must specify a customer, either by creating a new customer record inline
+or by passing in an existing Customer ID or Customer Ref.
+
+**Line Item Level Data**
+
+It's not strictly required, but we strongly recommend sending line item level
+data with every request.  It will make the invoice look a little more complete
+and the data format for line item level data is the exact same format used
+for terminal line item display, so the same code can be used to support both areas.
+
+**Descriptions**
+
+You can also send a free form description or message that's displayed near
+the bottom of the invoice.  Usually this is some kind of thank you note
+or instructions.
+
+**Terms and Conditions**
+
+You can include long form contract language with a request and capture
+terms and conditions acceptance at the same time payment is captured.
+
+The interface is identical to that used for the terminal based terms and
+conditions API in that you can pass in content directly via `tcContent` or via
+a preconfigured template via `tcAlias`.  The terms and conditions log will also be updated when
+terms and conditions acceptance is incorporated into a send link request.
+
+**Auto Send**
+
+By default, BlockChyp does not send the email notification automatically.  This is
+really just 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.
+
+**Payment Notifications**
+
+When a customer successfully submits payment, the merchant will receive an email
+notifying them that the payment was received.
+
+**Real Time Callback Notifications**
+
+Email notifications are fine, but you may also want your system to be informed
+immediately whenever a payment event occurs.  By using the optional `callbackUrl` request
+property, you can specify a URL to which the Authorization Response will be posted
+every time the user submits a payment, whether approved or otherwise.
+
+The response will be sent as a JSON encoded POST request and will be the exact
+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
+always use the Transaction Status API described below.
+
+A common use case for the send link API with status polling is curbside pickup.
+You could have your system check the Transaction Status when a customer arrives to
+ensure it's been paid without necessarily needing to create background threads
+to constantly poll for status updates.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_API_KEY'],
   ENV['BC_BEARER_TOKEN'],
   ENV['BC_SIGNING_KEY']
@@ -603,20 +781,51 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "terminalName": 'Test Terminal',
-  "transactionRef": '<LAST TRANSACTION REF>'
+  "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": 'support@blockchyp.com',
+    "smsNumber": '(123) 123-1231'
+  }
 }
 
-response = blockchyp.reverse(request)
+response = blockchyp.sendPaymentLink(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Capture Preauthorization
+#### Transaction Status
+
+
+
+Returns the current status for any transaction.  You can lookup a transaction
+by its BlockChyp assigned Transaction ID or your own Transaction Ref.
+
+You should alway use globally unique Transaction Ref values, but in the event
+that you duplicate Transaction Refs, the most recent transaction matching your
+Transaction Ref is returned.
+
 
-Captures a preauthorization.
 
 
 ```ruby
@@ -632,20 +841,25 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "transactionId": '<PREAUTH TRANSACTION ID>'
+  "transactionId": 'ID of transaction to retrieve'
 }
 
-response = blockchyp.capture(request)
+response = blockchyp.transactionStatus(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Close Batch
+#### Terminal Clear
+
+
+
+This API interrupts whatever a terminal may be doing and returns it to the
+idle state.
+
+
 
-Closes the current credit card batch.
 
 
 ```ruby
@@ -661,19 +875,33 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true
+  "test": true,
+  "terminalName": 'Test Terminal'
 }
 
-response = blockchyp.closeBatch(request)
+response = blockchyp.clear(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Void Transaction
+#### Terminal Status
+
+
+
+Returns the current status of a payment terminal.  This is typically used
+as a way to determine if the terminal is busy before sending a new transaction.
+
+If the terminal is busy, `idle` will be false and the `status` field will return
+a short string indicating the transaction type currently in progress.  The system
+will also return the timestamp of the last status change in the `since` field.
+
+If the system is running a payment transaction and you wisely passed in a
+Transaction Ref, this API will also return the Transaction Ref of the in progress
+transaction in the response.
+
 
-Discards a previous preauth transaction.
 
 
 ```ruby
@@ -689,20 +917,59 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "transactionId": '<PREVIOUS TRANSACTION ID>'
+  "terminalName": 'Test Terminal'
 }
 
-response = blockchyp.void(request)
+response = blockchyp.terminalStatus(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Terminal Status
+#### Terms & Conditions Capture
+
+
+
+This API allows you to prompt a customer to accept a legal agreement on the terminal
+and optionally capture their signature.
+
+Content for the agreement can be specified in two ways.  You can reference a
+previously configured T&C template or pass in the full agreement text with every request.
+
+**Using Templates**
+
+If your application doesn't keep track of agreements you can leverage BlockChyp's
+template system.  You can create any number of T&C Templates in the merchant dashboard
+and pass in the `tcAlias` flag to specify which one to display.
+
+**Raw Content**
+
+If your system keeps track of the agreement language or executes complicated merging
+and rendering logic, you can bypass our template system and pass in the full text with
+every transaction.  Use the `tcName` to pass in the agreement name and `tcContent` to
+pass in the contract text.  Note that only plain text is supported.
+
+**Bypassing Signatures**
+
+Signature images are captured by default.  If for some reason this doesn't fit your
+use case and you'd like to capture acceptance without actually capturing a signature image set
+the `disableSignature` flag in the request.
+
+**Terms & Conditions Log**
+
+Every time a user accepts an agreement on the terminal the signature image (if captured),
+will be uploaded to the gateway and added to the log along with the full text of the
+agreement.  This preserves the historical record in the event that standard agreements
+or templates change over time.
+
+**Associating Agreements with Transactions**
+
+To associate a Terms & Conditions log entry with a transaction, just pass in the
+Transaction ID or Transaction Ref for the associated transaction.
+
+
 
-Returns the current status of a terminal.
 
 
 ```ruby
@@ -718,19 +985,60 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "terminalName": 'Test Terminal'
+  "test": true,
+  "terminalName": 'Test Terminal',
+
+  # Alias for a Terms and Conditions template configured in the BlockChyp
+  # dashboard.
+  "tcAlias": 'hippa',
+
+  # Name of the contract or document if not using an alias.
+  "tcName": 'HIPPA Disclosure',
+
+  # Full text of the contract or disclosure if not using an alias.
+  "tcContent": 'Full contract text',
+
+  # File format for the signature image.
+  "sigFormat": SignatureFormat::PNG,
+
+  # Width of the signature image in pixels.
+  "sigWidth": 200,
+
+  # Whether or not a signature is required. Defaults to true.
+  "sigRequired": true
 }
 
-response = blockchyp.terminalStatus(request)
+response = blockchyp.termsAndConditions(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Capture Signature.
+#### Capture Signature
+
+
+
+This endpoint captures a written signature from the terminal and returns the
+image.
+
+Unlike the Terms & Conditions API, this endpoint performs basic signature
+capture with no agreement display or signature archival.
+
+Under the hood, signatures are captured in a proprietary vector format and
+must be converted to a common raster format in order to be useful to most
+applications.  At a minimum, you must specify an image format using the
+`sigFormat` parameter.  As of this writing JPG and PNG are supported.
+
+By default, images are returned in the JSON response as hex encoded binary.
+You can redirect the binary image output to a file using the `sigFile`
+parameter.
+
+You can also scale the output image to your preferred width by
+passing in a `sigWidth` parameter.  The image will be scaled to that
+width, preserving the aspect ratio of the original image.
+
 
-Captures and returns a signature.
 
 
 ```ruby
@@ -762,9 +1070,31 @@ puts "Response: #{response.inspect}"
 
 ```
 
-#### Update Customer
+#### New Transaction Display
+
+
+
+Sends totals and line item level data to the terminal.
+
+At a minimum, you should send total information as part of a display request,
+including `total`, `tax`, and `subtotal`.
+
+You can also send line item level data and each line item can have a `description`,
+`qty`, `price`, and `extended` price.
+
+If you fail to send an extended price, BlockChyp will multiply the `qty` by the
+`price`, but we strongly recommend you precalculate all the fields yourself
+to ensure consistency.  Your treatment of floating-point multiplication and rounding
+may differ slightly from BlockChyp's, for example.
+
+**Discounts**
+
+You have the option to show discounts on the display as individual line items
+with negative values or you can associate discounts with a specific line item.
+You can apply any number of discounts to an individual line item with a description
+and amount.
+
 
-Updates or creates a customer record.
 
 
 ```ruby
@@ -780,27 +1110,69 @@ 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'
+  "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": 'memberDiscount',
+            "amount": '10.00'
+          }
+        ]
+      }
+    ]
   }
 }
 
-response = blockchyp.updateCustomer(request)
+response = blockchyp.newTransactionDisplay(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Retrieve Customer
+#### Update Transaction Display
+
+
+
+Similar to *New Transaction Display*, this variant allows developers to update
+line item level data currently being displayed on the terminal.
+
+This is designed for situations where you want to update the terminal display as
+items are scanned.  This variant means you only have to send information to the
+terminal that's changed, which usually means the new line item and updated totals.
+
+If the terminal is not in line item display mode and you invoke this endpoint,
+the first invocation will behave like a *New Transaction Display* call.
+
+At a minimum, you should send total information as part of a display request,
+including `total`, `tax`, and `subtotal`.
+
+You can also send line item level data and each line item can have a `description`,
+`qty`, `price`, and `extended` price.
+
+If you fail to send an extended price, BlockChyp will multiply the `qty` by the
+`price`, but we strongly recommend you precalculate all the fields yourself
+to ensure consistency.  Your treatment of floating-point multiplication and rounding
+may differ slightly from BlockChyp's, for example.
+
+**Discounts**
+
+You have the option to show discounts on the display as individual line items
+with negative values or you can associate discounts with a specific line item.
+You can apply any number of discounts to an individual line item with a description
+and amount.
+
 
-Retrieves a customer by id.
 
 
 ```ruby
@@ -816,19 +1188,45 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "customerId": 'ID of the customer to retrieve'
+  "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": 'memberDiscount',
+            "amount": '10.00'
+          }
+        ]
+      }
+    ]
+  }
 }
 
-response = blockchyp.customer(request)
+response = blockchyp.updateTransactionDisplay(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Search Customer
+#### Display Message
+
+
+
+Displays a message on the payment terminal.
+
+Just specify the target terminal and the message using the `message` parameter.
+
 
-Searches the customer database.
 
 
 ```ruby
@@ -844,19 +1242,36 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "query": '(123) 123-1234'
+  "test": true,
+  "terminalName": 'Test Terminal',
+  "message": 'Thank you for your business.'
 }
 
-response = blockchyp.customerSearch(request)
+response = blockchyp.message(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Cash Discount
+#### Boolean Prompt
+
+
+
+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.
+
+This can be used for a number of use cases including starting a loyalty enrollment
+workflow or customer facing suggestive selling prompts.
+
+**Custom Captions**
+
+You can optionally override the "YES" and "NO" button captions by
+using the `yesCaption` and `noCaption` request parameters.
+
 
-Calculates the discount for actual cash transactions.
 
 
 ```ruby
@@ -872,19 +1287,47 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "amount": '100.00'
+  "test": true,
+  "terminalName": 'Test Terminal',
+  "prompt": 'Would you like to become a member?',
+  "yesCaption": 'Yes',
+  "noCaption": 'No'
 }
 
-response = blockchyp.cashDiscount(request)
+response = blockchyp.booleanPrompt(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Transaction Status
+#### Text Prompt
+
+
+
+Prompts the customer to enter numeric or alphanumeric data.
+
+Due to PCI rules, free form prompts are not permitted when the response
+could be any valid string.  The reason for this is that a malicious
+developer (not you, of course) could use text prompts to ask the customer to
+input a card number or PIN code.
+
+This means that instead of providing a prompt, you provide a `promptType` instead.
+
+The prompt types currently supported are listed below:
+
+* **phone**: Captures a phone number.
+* **email**: Captures an email address.
+* **first-name**: Captures a first name.
+* **last-name**: Captures a last name.
+* **customer-number**: Captures a customer number.
+* **rewards-number**: Captures a rewards number.
+
+You can specify the prompt with the `promptType` parameter and
+the response is returned in the `response` field.
+
+
 
-Retrieves the current status of a transaction.
 
 
 ```ruby
@@ -900,19 +1343,50 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "transactionId": 'ID of transaction to retrieve'
+  "test": true,
+  "terminalName": 'Test Terminal',
+
+  # Type of prompt. Can be 'email', 'phone', 'customer-number', or
+  # 'rewards-number'.
+  "promptType": PromptType::EMAIL
 }
 
-response = blockchyp.transactionStatus(request)
+response = blockchyp.textPrompt(request)
 
 puts "Response: #{response.inspect}"
 
 
 ```
 
-#### Send Payment Link
+#### Update Customer
+
+
+
+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
+be created.
+
+If you pass in `customerRef` and `customerId`, the customer record will be updated
+if it exists.
+
+**Customer Ref**
+
+The `customerRef` field is optional, but highly recommended as this allows you
+to use your own customer identifiers instead of storing BlockChyp's Customer IDs
+in your systems.
+
+**Creating Customer Records With Payment Transactions**
+
+If you have customer information available at the time a payment transaction is
+executed, you can pass all the same customer information directly into a payment transaction and
+create a customer record at the same time payment is captured.  The advantage of this approach is
+that the customer's payment card is automatically associated with the customer record in a single step.
+If the customer uses the payment card in the future, the customer data will automatically
+be returned without needing to ask the customer to provide any additional information.
+
 
-Creates and send a payment link to a customer.
 
 
 ```ruby
@@ -928,23 +1402,8 @@ 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": [
-      {
-        "description": 'Widget',
-        "price": '195.00',
-        "quantity": 1
-      }
-    ]
-  },
-  "autoSend": true,
   "customer": {
+    "id": 'ID of the customer to update',
     "customerRef": 'Customer reference string',
     "firstName": 'FirstName',
     "lastName": 'LastName',
@@ -954,7 +1413,115 @@ request = {
   }
 }
 
-response = blockchyp.sendPaymentLink(request)
+response = blockchyp.updateCustomer(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Retrieve Customer
+
+
+
+Retrieves detailed information about a customer record, including saved payment
+methods if available.
+
+Customers can be looked up by `customerId` or `customerRef`.
+
+
+
+
+```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 = {
+  "customerId": 'ID of the customer to retrieve'
+}
+
+response = blockchyp.customer(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Search Customer
+
+
+
+Searches the customer database and returns matching results.
+
+Use `query` to pass in a search string and the system will return all results whose
+first or last names contain the query string.
+
+
+
+
+```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 = {
+  "query": '(123) 123-1234'
+}
+
+response = blockchyp.customerSearch(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Cash Discount
+
+
+
+Calculates the surcharge, cash discount, and total amounts for cash transactions.
+
+If you're using BlockChyp's cash discounting features, you can use this endpoint
+to make sure the numbers and receipts for true cash transactions are consistent
+with transactions processed by BlockChyp.
+
+
+
+
+```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 = {
+  "amount": '100.00',
+  "cashDiscount": true,
+  "surcharge": true
+}
+
+response = blockchyp.cashDiscount(request)
 
 puts "Response: #{response.inspect}"