BlockChypClient (com.blockchyp:blockchyp-java 1.0.0 API)

java.lang.Object
- com.blockchyp.client.BlockChypClient

```
public class BlockChypClient
extends Object
```
This is the main class Java developers will interact with. You can instantiate this class directly or use it with a dependency injection framework like Spring or Guice. Most developers will only need to inject credentials, but you may also want to override default endpoints if you're targeting non production BlockChyp systems (which is unlikely). You can inject settings via the constructors or via setters depending on your preferences. You'll also notice that we're not using generics or any features from Java 1.7 or later. This is just to maintain as much backward compatibility as possible with older systems (1.6 or later). The underlying REST API's are invoked using commons-httpclient 3.1 and we use Jackson for JSON serialization. Most internal methods are scoped as protected in order to give developers the ability to override things if they need special behavior or have weird classpath issues.

Field Summary

Fields
Modifier and Type Field and Description

static long MS_PER_HOUR

static String OFFLINE_CACHE

static String OFFLINE_FIXED_KEY

Fields
Modifier and Type	Field and Description
`static long`	`MS_PER_HOUR`
`static String`	`OFFLINE_CACHE`
`static String`	`OFFLINE_FIXED_KEY`

Constructor Summary

Constructors
Constructor and Description
`BlockChypClient()` Default constructor.
`BlockChypClient(APICredentials defaultCredentials)` Provided as a convenience to support constructor based dependency injection.
`BlockChypClient(String gatewayHost)` Provided as a convenience to support constructor based dependency injection.
`BlockChypClient(String gatewayHost, APICredentials defaultCredentials)` Provided as a convenience to support constructor based dependency injection.
`BlockChypClient(String gatewayHost, String testGatewayHost, APICredentials defaultCredentials)` Provided as a convenience to support constructor based dependency injection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BooleanPromptResponse`	`booleanPrompt(BooleanPromptRequest request)` Asks the user a yes or no question.
`CaptureResponse`	`capture(CaptureRequest request)` Captures a preauth.
`AuthorizationResponse`	`charge(AuthorizationRequest request)` Performs a standard auth and capture.
`Acknowledgement`	`clear(ClearTerminalRequest request)` Clears the terminal of any in progress transactions or line item information.
`CloseBatchResponse`	`closeBatch(CloseBatchRequest request)` Executes a manual batch close.
`protected APICredentials`	`decrypt(APICredentials creds)` Decrypts API credentials using the offline cache key.
`protected byte[]`	`deriveOfflineKey()` Generates the encryption key used for offline cache records.
`protected void`	`dumpSignatureFile(PaymentRequest request, AuthorizationResponse response)` Writes the signature to a file if a signature is present and the caller has requested it.
`protected APICredentials`	`encrypt(APICredentials creds)` Encrypts API credentials using the offline cache key.
`AuthorizationResponse`	`enroll(AuthorizationRequest request)` Enrolls the payment method in the recurring payment token vault.
`protected Object`	`finishGatewayRequest(org.apache.commons.httpclient.HttpMethod method, Class responseType)` Executes a previously assembled HttpMethod against the gateway.
`protected Object`	`finishTerminalRequest(TerminalRouteResponse route, Object request, org.apache.commons.httpclient.methods.EntityEnclosingMethod method, Class responseType)` This handles all the common logic associated with processing terminal http requests.
`protected Object`	`getGateway(String path, boolean test, Class responseType)` Executes an http get request against the gateway with a timeout override.
`protected Object`	`getGateway(String path, boolean test, Class responseType, int requestTimeout)` Executes an http get request against the gateway with a timeout override.
`protected org.apache.commons.httpclient.HttpClient`	`getGatewayClient()` Returns the gateway client singleton.
`TerminalRouteResponse`	`getOfflineCache(String terminalName)` Returns the route stored in the offline cache for the given terminal.
`String`	`getOfflineRouteCacheLocation()` Returns the offline route cache location.
`protected org.apache.commons.httpclient.HttpClient`	`getTerminalClient()` Returns the terminal client singleton.
`HeartbeatResponse`	`heartbeat(boolean test)` Tests communication with the Gateway.
`protected void`	`initObjectMapper()` Initializes the JSON encoder and parser.
`boolean`	`isTerminalHttps()` Gets the terminal https flag.
`protected boolean`	`isTerminalRouted(ITerminalReference terminalName)` Returns true if transaction for the given terminal reference should be routed over the local subnet.
`Acknowledgement`	`message(MessageRequest request)` Displays a text message on the terminal screen.
`protected TerminalRequest`	`newTerminalRequestForRoute(TerminalRouteResponse route)` Assembles a new terminal request and populates the credentials, using transient credentials if available.
`Acknowledgement`	`newTransactionDisplay(TransactionDisplayRequest request)` Resets the line item display.
`Acknowledgement`	`ping(PingRequest request)` Tests local communication with a terminal.
`protected void`	`populateSignatureOptions(PaymentRequest request)` This method is used to setup sensible defaults for local signature file dumps.
`protected Object`	`postGateway(String path, CoreRequest request, Class responseClass)` Executes a post HTTP request against the gateway.
`protected Object`	`postTerminal(String path, Object request, Class responseType)` Posts an http request to the terminal API.
`AuthorizationResponse`	`preauth(AuthorizationRequest request)` Preauthorizes a transaction.
`protected Object`	`putGateway(String path, CoreRequest request, Class responseClass)` Executes a put HTTP request against the gateway.
`protected Object`	`putTerminal(String path, Object request, Class responseType)` Executes a put http request against the terminal API.
`AuthorizationResponse`	`refund(RefundRequest request)` Refunds a transaction.
`protected String`	`resolveOfflineRouteCacheLocation(String terminalName)` Returns the offline cache location.
`protected String`	`resolveTerminalHost(TerminalRouteResponse route)` Assembles the scheme, ip address, and port number bits of a terminal URL.
`protected TerminalRouteResponse`	`resolveTerminalRoute(String terminalName)` Finds the terminal route record for the given terminal name.
`AuthorizationResponse`	`reverse(AuthorizationRequest request)` Executes a time out reversal.
`protected TerminalRouteResponse`	`routeCacheGet(String terminalName)` Looks up a terminal route from the cache.
`protected void`	`routeCachePut(TerminalRouteResponse route)` Puts a terminal route in the cache (both caches).
`void`	`setDefaultCredentials(APICredentials defaultCredentials)` Sets the default root API credentials for the client.
`void`	`setGatewayHost(String gatewayHost)` Used to override the live gateway host.
`void`	`setOfflineRouteCacheEnabled(boolean offlineRouteCacheEnabled)` Enables or disables offline terminal route caching.
`void`	`setOfflineRouteCacheLocation(String offlineRouteCacheLocation)` Sets the offline route cache location if you want to override the default.
`void`	`setPaymentLogger(PaymentLogger paymentLogger)` Sets the payment logger.
`void`	`setTerminalHttps(boolean terminalHttps)` Sets the terminal https flag.
`void`	`setTestGatewayHost(String testGatewayHost)` Used to override the test gateway host.
`TextPromptResponse`	`textPrompt(TextPromptRequest request)` Captures text input from the user.
`protected String`	`toFullyQualifiedGatewayPath(String path, boolean test)` Converts path to the fully qualified URL for a gateway API call.
`protected String`	`toFullyQualifiedTerminalPath(TerminalRouteResponse route, String path)` Assembles a full path to the terminal for an API call.
`protected String`	`toTerminalRouteKey(String terminalName)` Creates a cache key for terminal routes.
`Acknowledgement`	`updateTransactionDisplay(TransactionDisplayRequest request)` Updates the line item display.
`VoidResponse`	`voidTx(VoidRequest request)` Voids a transaction.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OFFLINE_CACHE
```
public static final String OFFLINE_CACHE
```
    See Also:
    
    Constant Field Values
  - OFFLINE_FIXED_KEY
```
public static final String OFFLINE_FIXED_KEY
```
    See Also:
    
    Constant Field Values
  - MS_PER_HOUR
```
public static final long MS_PER_HOUR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BlockChypClient
```
public BlockChypClient()
```
    Default constructor.
  - BlockChypClient
```
public BlockChypClient(String gatewayHost)
```
    Provided as a convenience to support constructor based dependency injection.
    
    Parameters:
    
    gatewayHost - alternate gateway endpoint.
  - BlockChypClient
```
public BlockChypClient(APICredentials defaultCredentials)
```
    Provided as a convenience to support constructor based dependency injection.
    
    Parameters:
    
    defaultCredentials - APICredentials
  - BlockChypClient
```
public BlockChypClient(String gatewayHost,
                       APICredentials defaultCredentials)
```
    Provided as a convenience to support constructor based dependency injection.
    
    Parameters:
    
    gatewayHost - - alternate gateway endpoint.
    
    defaultCredentials - APICredentials
  - BlockChypClient
```
public BlockChypClient(String gatewayHost,
                       String testGatewayHost,
                       APICredentials defaultCredentials)
```
    Provided as a convenience to support constructor based dependency injection.
    
    Parameters:
    
    gatewayHost - alternate gateway endpoint.
    
    testGatewayHost - alternate gateway endpoint.
    
    defaultCredentials - APICredentials
- Method Detail
  - setGatewayHost
```
public void setGatewayHost(String gatewayHost)
```
    Used to override the live gateway host. Unless you work at BlockChyp, you probably won't ever need to do this.
    
    Parameters:
    
    gatewayHost - alternate gateway endpoint.
  - setTestGatewayHost
```
public void setTestGatewayHost(String testGatewayHost)
```
    Used to override the test gateway host. Unless you work at BlockChyp, you probably won't ever need to do this.
    
    Parameters:
    
    testGatewayHost - alternate gateway endpoint.
  - setDefaultCredentials
```
public void setDefaultCredentials(APICredentials defaultCredentials)
```
    Sets the default root API credentials for the client.
    
    Parameters:
    
    defaultCredentials - APICredentials
  - setOfflineRouteCacheEnabled
```
public void setOfflineRouteCacheEnabled(boolean offlineRouteCacheEnabled)
```
    Enables or disables offline terminal route caching. Offline route caching is really meant as a defense for situations where developers are creating new BlockChypClient instances over and over for each request and therefore making the in memory cache useless. The BlockChypClient is thread safe so we encourage you to only create one instance and share it for all requests. If you're doing this, you can safely disable offline route caching and we recommend it. Defaults to enabled.
    
    Parameters:
    
    offlineRouteCacheEnabled - true if offline route caching is enabled.
  - setPaymentLogger
```
public void setPaymentLogger(PaymentLogger paymentLogger)
```
    Sets the payment logger. Can be used to override that default System.out based logging.
    
    Parameters:
    
    paymentLogger - an implementation of PaymentLogger
  - initObjectMapper
```
protected void initObjectMapper()
```
    Initializes the JSON encoder and parser.
  - heartbeat
```
public HeartbeatResponse heartbeat(boolean test)
                            throws Exception
```
    Tests communication with the Gateway. If authentication is successful, a merchantPk value is returned.
    
    Parameters:
    
    test - whether or not to route the the transaction to the test gateway.
    
    Returns:
    
    Acknowledgement
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - ping
```
public Acknowledgement ping(PingRequest request)
                     throws Exception
```
    Tests local communication with a terminal.
    
    Parameters:
    
    request - PingRequest
    
    Returns:
    
    Acknowledgement
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - enroll
```
public AuthorizationResponse enroll(AuthorizationRequest request)
                             throws Exception
```
    Enrolls the payment method in the recurring payment token vault. Any amounts passed in are ignored.
    
    Parameters:
    
    request - AuthorizationRequest
    
    Returns:
    
    AuthorizationResponse
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - charge
```
public AuthorizationResponse charge(AuthorizationRequest request)
                             throws Exception
```
    Performs a standard auth and capture.
    
    Parameters:
    
    request - AuthorizationRequest
    
    Returns:
    
    AuthorizationResponse
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - reverse
```
public AuthorizationResponse reverse(AuthorizationRequest request)
                              throws Exception
```
    Executes a time out reversal. You should use this API in situations where your requests for authorizations time out or give ambiguous results. Must be done within two minutes of the original authorization. Will help prevent double charge issues. To use this method, you'll need to provide a transationRef value to uniquely identify your transactions. It's designed such that you can take the original AuthorizationRequest you assembled for the charge or preauth and just resend it as a reverse. Bear in mind that terminals always automatically reverse transactions if there's trouble with terminal to gateway communication or the customer doesn't provide a signature when signatures are required.
    
    Parameters:
    
    request - AuthorizationRequest
    
    Returns:
    
    AuthorizationResponse
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - closeBatch
```
public CloseBatchResponse closeBatch(CloseBatchRequest request)
                              throws Exception
```
    Executes a manual batch close. BlockChyp defaults to automatically closing batches at 3 AM in the merchant's local time zone. You can turn this off and batch manually if you want. You might need to do this for preauth based businesses (restaurants and bars) with unusual hours.
    
    Parameters:
    
    request - CloseBatchRequest
    
    Returns:
    
    CloseBatchResponse
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - refund
```
public AuthorizationResponse refund(RefundRequest request)
                             throws Exception
```
    Refunds a transaction. You can execute a full or partial refund referencing a previous transaction. You can also do a free range refund without referencing a previous transaction, but please, pretty please, don't do this. Basing a refund on a previous transaction is way more secure.
    
    Parameters:
    
    request - RefundRequest
    
    Returns:
    
    AuthorizationResponse
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - preauth
```
public AuthorizationResponse preauth(AuthorizationRequest request)
                              throws Exception
```
    Preauthorizes a transaction. Must be captured later.
    
    Parameters:
    
    request - AuthorizationRequest
    
    Returns:
    
    AuthorizationResponse
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - message
```
public Acknowledgement message(MessageRequest request)
                        throws Exception
```
    Displays a text message on the terminal screen.
    
    Parameters:
    
    request - MessageRequest
    
    Returns:
    
    Acknowledgement
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - textPrompt
```
public TextPromptResponse textPrompt(TextPromptRequest request)
                              throws Exception
```
    Captures text input from the user. This can be used for things like email addresses, phone numbers, and loyalty program numbers. You have to specify a promptType in the request since free form prompt text isn't permitted for text input prompts per PCI.
    
    Parameters:
    
    request - TextPromptRequest
    
    Returns:
    
    TextPromptResponse
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - booleanPrompt
```
public BooleanPromptResponse booleanPrompt(BooleanPromptRequest request)
                                    throws Exception
```
    Asks the user a yes or no question. You can use this for things like suggestive selling. You can also use this for surveys, but BlockChyp does have a built in survey feature that your merchants can use without any coding needed.
    
    Parameters:
    
    request - BooleanPromptRequest
    
    Returns:
    
    BooleanPromptResponse
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - newTransactionDisplay
```
public Acknowledgement newTransactionDisplay(TransactionDisplayRequest request)
                                      throws Exception
```
    Resets the line item display. This will clear any existing line items and start over. Use this method if you need to delete line items.
    
    Parameters:
    
    request - TransactionDisplayRequest
    
    Returns:
    
    Acknowledgement
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - clear
```
public Acknowledgement clear(ClearTerminalRequest request)
                      throws Exception
```
    Clears the terminal of any in progress transactions or line item information. Returns it to the idle state.
    
    Parameters:
    
    request - ClearTerminalRequest
    
    Returns:
    
    Acknowledgement
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - updateTransactionDisplay
```
public Acknowledgement updateTransactionDisplay(TransactionDisplayRequest request)
                                         throws Exception
```
    Updates the line item display. This will add new line items to the terminal and update totals.
    
    Parameters:
    
    request - TransactionDisplayRequest
    
    Returns:
    
    Acknowledgement
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - capture
```
public CaptureResponse capture(CaptureRequest request)
                        throws Exception
```
    Captures a preauth. Captures are always routed to the gateway.
    
    Parameters:
    
    request - CaptureRequest
    
    Returns:
    
    CaptureResponse
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - voidTx
```
public VoidResponse voidTx(VoidRequest request)
                    throws Exception
```
    Voids a transaction. Voids are always routed to the gateway.
    
    Parameters:
    
    request - VoidRequest
    
    Returns:
    
    VoidResponse
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - decrypt
```
protected APICredentials decrypt(APICredentials creds)
```
    Decrypts API credentials using the offline cache key.
    
    Parameters:
    
    creds - blockchyp API credentials.
    
    Returns:
    
    a decrypted copy of the original credentials.
  - encrypt
```
protected APICredentials encrypt(APICredentials creds)
```
    Encrypts API credentials using the offline cache key.
    
    Parameters:
    
    creds - blockchyp API credentials.
    
    Returns:
    
    an encrypted copy of the original credentials.
  - deriveOfflineKey
```
protected byte[] deriveOfflineKey()
```
    Generates the encryption key used for offline cache records.
    
    Returns:
    
    the key in bytes.
  - routeCacheGet
```
protected TerminalRouteResponse routeCacheGet(String terminalName)
```
    Looks up a terminal route from the cache.
    
    Parameters:
    
    terminalName - terminal name assigned at activation.
    
    Returns:
    
    the terminal route record.
  - routeCachePut
```
protected void routeCachePut(TerminalRouteResponse route)
```
    Puts a terminal route in the cache (both caches).
    
    Parameters:
    
    route - the terminal route record.
  - toTerminalRouteKey
```
protected String toTerminalRouteKey(String terminalName)
```
    Creates a cache key for terminal routes.
    
    Parameters:
    
    terminalName - terminal name.
    
    Returns:
    
    terminal cache key.
  - populateSignatureOptions
```
protected void populateSignatureOptions(PaymentRequest request)
```
    This method is used to setup sensible defaults for local signature file dumps. For example, if the sig file is provided without a format, it's possible to infer a format from the file extension. Note that we don't validate that the file format is supported. We leave that to the terminal firmware in order to prevent SDK updates being needed when file format support in the firmware changes.
    
    Parameters:
    
    request - PaymentRequest
  - dumpSignatureFile
```
protected void dumpSignatureFile(PaymentRequest request,
                                 AuthorizationResponse response)
```
    Writes the signature to a file if a signature is present and the caller has requested it. Notice this does not throw exceptions in order to prevent the calling application from losing track of the authorization.
    
    Parameters:
    
    request - PaymentRequest
    
    response - AuthorizationResponse
  - resolveTerminalRoute
```
protected TerminalRouteResponse resolveTerminalRoute(String terminalName)
```
    Finds the terminal route record for the given terminal name. First the local in memory cache is checked, then the offline cache (if enabled). If the first two cache lookups come up empty or the cache is over an hour old, the gateway route API is invoked. If we have a stale cache entry and the gateway route lookup fails or times out, we fall back to the stale cache entry.
    
    Parameters:
    
    terminalName - name of the terminal assigned at activation.
    
    Returns:
    
    the terminal route record.
  - getGatewayClient
```
protected org.apache.commons.httpclient.HttpClient getGatewayClient()
```
    Returns the gateway client singleton.
    
    Returns:
    
    HttpClient configured for gateway requests.
  - getTerminalClient
```
protected org.apache.commons.httpclient.HttpClient getTerminalClient()
```
    Returns the terminal client singleton.
    
    Returns:
    
    HttpClient configured for terminal requests.
  - resolveTerminalHost
```
protected String resolveTerminalHost(TerminalRouteResponse route)
```
    Assembles the scheme, ip address, and port number bits of a terminal URL.
    
    Parameters:
    
    route - the terminal route record.
    
    Returns:
    
    scheme, ip addres, and port number.
  - toFullyQualifiedTerminalPath
```
protected String toFullyQualifiedTerminalPath(TerminalRouteResponse route,
                                              String path)
```
    Assembles a full path to the terminal for an API call.
    
    Parameters:
    
    route - the terminal route record.
    
    path - API path relative to the root (e.g. "/api/charge")
    
    Returns:
    
    the fully qualified URI.
  - isTerminalRouted
```
protected boolean isTerminalRouted(ITerminalReference terminalName)
```
    Returns true if transaction for the given terminal reference should be routed over the local subnet.
    
    Parameters:
    
    terminalName - reference to the terminal.
    
    Returns:
    
    true, if terminal (local subnet) routed.
  - finishTerminalRequest
```
protected Object finishTerminalRequest(TerminalRouteResponse route,
                                       Object request,
                                       org.apache.commons.httpclient.methods.EntityEnclosingMethod method,
                                       Class responseType)
                                throws Exception
```
    This handles all the common logic associated with processing terminal http requests.
    
    Parameters:
    
    route - the terminal route record
    
    request - the request payload, if put or post
    
    method - the HttpMethod prepopulated
    
    responseType - expected response type.
    
    Returns:
    
    a response of type specified by responseClass
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - putTerminal
```
protected Object putTerminal(String path,
                             Object request,
                             Class responseType)
                      throws Exception
```
    Executes a put http request against the terminal API.
    
    Parameters:
    
    path - api path relative to the root (e.g. "/api/charge")
    
    request - the request payload object.
    
    responseType - expected response type.
    
    Returns:
    
    a response of type specified by responseClass
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - newTerminalRequestForRoute
```
protected TerminalRequest newTerminalRequestForRoute(TerminalRouteResponse route)
```
    Assembles a new terminal request and populates the credentials, using transient credentials if available.
    
    Parameters:
    
    route - the terminal route record.
    
    Returns:
    
    TerminalRequest
  - postTerminal
```
protected Object postTerminal(String path,
                              Object request,
                              Class responseType)
                       throws Exception
```
    Posts an http request to the terminal API.
    
    Parameters:
    
    path - api path relative to the root (e.g. "/api/charge")
    
    request - the request payload object.
    
    responseType - expected response type.
    
    Returns:
    
    a response of type specified by responseClass
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - getGateway
```
protected Object getGateway(String path,
                            boolean test,
                            Class responseType)
                     throws Exception
```
    Executes an http get request against the gateway with a timeout override.
    
    Parameters:
    
    path - api path relative to the root (e.g. "/api/heartbeat")
    
    test - whether or not this request should go to the test gateway
    
    responseType - expected response type.
    
    Returns:
    
    a response of type specified by responseClass
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - getGateway
```
protected Object getGateway(String path,
                            boolean test,
                            Class responseType,
                            int requestTimeout)
                     throws Exception
```
    Executes an http get request against the gateway with a timeout override.
    
    Parameters:
    
    path - API path relative to the root (e.g. "/api/heartbeat")
    
    test - whether or not this request should go to the test gateway
    
    responseType - expected response type.
    
    requestTimeout - timeout for the request in milliseconds
    
    Returns:
    
    a response of type specified by responseClass
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - finishGatewayRequest
```
protected Object finishGatewayRequest(org.apache.commons.httpclient.HttpMethod method,
                                      Class responseType)
                               throws Exception
```
    Executes a previously assembled HttpMethod against the gateway. Aggregates common logic associated with hitting the gateway.
    
    Parameters:
    
    method - the HttpMethod to execute.
    
    responseType - expected response type.
    
    Returns:
    
    a response of type specified by responseClass
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - postGateway
```
protected Object postGateway(String path,
                             CoreRequest request,
                             Class responseClass)
                      throws Exception
```
    Executes a post HTTP request against the gateway.
    
    Parameters:
    
    path - API path from root (e.g. "/api/charge")
    
    request - the request object.
    
    responseClass - expected response type.
    
    Returns:
    
    a response of type specified by responseClass
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - putGateway
```
protected Object putGateway(String path,
                            CoreRequest request,
                            Class responseClass)
                     throws Exception
```
    Executes a put HTTP request against the gateway.
    
    Parameters:
    
    path - API path from root (e.g. "/api/charge")
    
    request - the request object.
    
    responseClass - expected response type.
    
    Returns:
    
    a reponse of type specified by responseClass
    
    Throws:
    
    Exception - exception if any errors occurred processing the request.
  - resolveOfflineRouteCacheLocation
```
protected String resolveOfflineRouteCacheLocation(String terminalName)
```
    Returns the offline cache location. This will be the value of offlineRouteCacheLocation if specified and the operation system default tmp folder otherwise.
    
    Parameters:
    
    terminalName - the target terminal name.
    
    Returns:
    
    local path.
  - getOfflineCache
```
public TerminalRouteResponse getOfflineCache(String terminalName)
```
    Returns the route stored in the offline cache for the given terminal.
    
    Parameters:
    
    terminalName - the target terminal name.
    
    Returns:
    
    terminal route, null if not found.
  - getOfflineRouteCacheLocation
```
public String getOfflineRouteCacheLocation()
```
    Returns the offline route cache location.
    
    Returns:
    
    offline route cache location.
  - setOfflineRouteCacheLocation
```
public void setOfflineRouteCacheLocation(String offlineRouteCacheLocation)
```
    Sets the offline route cache location if you want to override the default. Defaults to your operation system's tmp file location.
    
    Parameters:
    
    offlineRouteCacheLocation - offline route cache location.
  - toFullyQualifiedGatewayPath
```
protected String toFullyQualifiedGatewayPath(String path,
                                             boolean test)
```
    Converts path to the fully qualified URL for a gateway API call.
    
    Parameters:
    
    path - path relative to the root (e.g. "/api/charge")
    
    test - whether or not this should route to the test transaction.
    
    Returns:
    
    fully qualified URI.
  - isTerminalHttps
```
public boolean isTerminalHttps()
```
    Gets the terminal https flag. The Java SDK defaults to using http for terminal communication because installing custom root certificate authorities in Java is quite tricky and cannot be done programmatically. We strongly recommend that all developers install our root CA in your local keystores and then turn https on in production. Our terminal root CA can be found here: https://docs.blockchyp.com/rest-api/terminal/index.html#ssl-tls
    
    Returns:
    
    https flag.
  - setTerminalHttps
```
public void setTerminalHttps(boolean terminalHttps)
```
    Sets the terminal https flag. The Java SDK defaults to using http for terminal communication because installing custom root certificate authorities in Java is quite tricky and cannot be done programmatically. We strongly recommend that all developers install our root CA in your local keystores and then turn https on in production. Our terminal root CA can be found here: https://docs.blockchyp.com/rest-api/terminal/index.html#ssl-tls
    
    Parameters:
    
    terminalHttps - https flag.

Class BlockChypClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OFFLINE_CACHE

OFFLINE_FIXED_KEY

MS_PER_HOUR

Constructor Detail

BlockChypClient

BlockChypClient

BlockChypClient

BlockChypClient

BlockChypClient

Method Detail

setGatewayHost

setTestGatewayHost

setDefaultCredentials

setOfflineRouteCacheEnabled

setPaymentLogger

initObjectMapper

heartbeat

ping

enroll

charge

reverse

closeBatch

refund

preauth

message

textPrompt

booleanPrompt

newTransactionDisplay

clear

updateTransactionDisplay

capture

voidTx

decrypt

encrypt

deriveOfflineKey

routeCacheGet

routeCachePut

toTerminalRouteKey

populateSignatureOptions

dumpSignatureFile

resolveTerminalRoute

getGatewayClient

getTerminalClient

resolveTerminalHost

toFullyQualifiedTerminalPath

isTerminalRouted

finishTerminalRequest

putTerminal

newTerminalRequestForRoute

postTerminal

getGateway

getGateway

finishGatewayRequest

postGateway

putGateway

resolveOfflineRouteCacheLocation

getOfflineCache

getOfflineRouteCacheLocation

setOfflineRouteCacheLocation

toFullyQualifiedGatewayPath

isTerminalHttps

setTerminalHttps