Skip navigation links
A B C D E F G H I M N O P R S T U V W 

A

Acknowledgement - Class in com.blockchyp.client.dto
Models basic response information.
Acknowledgement() - Constructor for class com.blockchyp.client.dto.Acknowledgement
 
addDiscount(TransactionDisplayDiscount) - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Adds a discount to the line item.
addItem(TransactionDisplayItem) - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Adds a line item to the transaction.
AES_KEY_SIZE_IN_BYTES - Static variable in class com.blockchyp.client.crypto.CryptoUtils
 
AmountRequest - Class in com.blockchyp.client.dto
Adds amount information to requests that require amounts to be specified.
AmountRequest() - Constructor for class com.blockchyp.client.dto.AmountRequest
 
APICredentials - Class in com.blockchyp.client.dto
Encapsulates the big three BlockChyp API credentials.
APICredentials() - Constructor for class com.blockchyp.client.dto.APICredentials
Default constructor.
APICredentials(String, String, String) - Constructor for class com.blockchyp.client.dto.APICredentials
Alternate constructor that initializes all the credential fields.
ApprovalResponse - Class in com.blockchyp.client.dto
This is a primitive base class for responses that include some kind of network approval information.
ApprovalResponse() - Constructor for class com.blockchyp.client.dto.ApprovalResponse
 
ApprovalResponseWithAmounts - Class in com.blockchyp.client.dto
Models the amount data for transaction responses that have associated currency amounts.
ApprovalResponseWithAmounts() - Constructor for class com.blockchyp.client.dto.ApprovalResponseWithAmounts
 
ApprovalResponseWithPaymentMethod - Class in com.blockchyp.client.dto
Models payment method information associated with a transaction response.
ApprovalResponseWithPaymentMethod() - Constructor for class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
 
AUTH_SCHEME_DUAL - Static variable in class com.blockchyp.client.crypto.CryptoUtils
 
AuthorizationRequest - Class in com.blockchyp.client.dto
Models the full detail needed for authorization requests.
AuthorizationRequest() - Constructor for class com.blockchyp.client.dto.AuthorizationRequest
 
AuthorizationResponse - Class in com.blockchyp.client.dto
Models a terminal authorization response.
AuthorizationResponse() - Constructor for class com.blockchyp.client.dto.AuthorizationResponse
 

B

BlockChypClient - Class in com.blockchyp.client
This is the main class Java developers will interact with.
BlockChypClient() - Constructor for class com.blockchyp.client.BlockChypClient
Default constructor.
BlockChypClient(String) - Constructor for class com.blockchyp.client.BlockChypClient
Provided as a convenience to support constructor based dependency injection.
BlockChypClient(APICredentials) - Constructor for class com.blockchyp.client.BlockChypClient
Provided as a convenience to support constructor based dependency injection.
BlockChypClient(String, APICredentials) - Constructor for class com.blockchyp.client.BlockChypClient
Provided as a convenience to support constructor based dependency injection.
BlockChypClient(String, String, APICredentials) - Constructor for class com.blockchyp.client.BlockChypClient
Provided as a convenience to support constructor based dependency injection.
booleanPrompt(BooleanPromptRequest) - Method in class com.blockchyp.client.BlockChypClient
Asks the user a yes or no question.
BooleanPromptRequest - Class in com.blockchyp.client.dto
Models information needed for boolean prompt support.
BooleanPromptRequest() - Constructor for class com.blockchyp.client.dto.BooleanPromptRequest
 
BooleanPromptResponse - Class in com.blockchyp.client.dto
Models the response for a terminal boolean prompt.
BooleanPromptResponse() - Constructor for class com.blockchyp.client.dto.BooleanPromptResponse
 

C

capture(CaptureRequest) - Method in class com.blockchyp.client.BlockChypClient
Captures a preauth.
CaptureRequest - Class in com.blockchyp.client.dto
Models the information needed to capture a preauthorization.
CaptureRequest() - Constructor for class com.blockchyp.client.dto.CaptureRequest
 
CaptureResponse - Class in com.blockchyp.client.dto
Models the response to a capture transaction.
CaptureResponse() - Constructor for class com.blockchyp.client.dto.CaptureResponse
 
charge(AuthorizationRequest) - Method in class com.blockchyp.client.BlockChypClient
Performs a standard auth and capture.
clear(ClearTerminalRequest) - Method in class com.blockchyp.client.BlockChypClient
Clears the terminal of any in progress transactions or line item information.
ClearTerminalRequest - Class in com.blockchyp.client.dto
Used to reset a terminal.
ClearTerminalRequest() - Constructor for class com.blockchyp.client.dto.ClearTerminalRequest
 
closeBatch(CloseBatchRequest) - Method in class com.blockchyp.client.BlockChypClient
Executes a manual batch close.
CloseBatchRequest - Class in com.blockchyp.client.dto
Models a request to close the current batch.
CloseBatchRequest() - Constructor for class com.blockchyp.client.dto.CloseBatchRequest
 
CloseBatchResponse - Class in com.blockchyp.client.dto
Models the response to a close batch request.
CloseBatchResponse() - Constructor for class com.blockchyp.client.dto.CloseBatchResponse
 
com.blockchyp.client - package com.blockchyp.client
 
com.blockchyp.client.crypto - package com.blockchyp.client.crypto
 
com.blockchyp.client.dto - package com.blockchyp.client.dto
 
computeSHA256(String) - Method in class com.blockchyp.client.crypto.CryptoUtils
Computes a SHA 256 hash of the given hex.
CoreRequest - Class in com.blockchyp.client.dto
Models common information for all SDK requests.
CoreRequest() - Constructor for class com.blockchyp.client.dto.CoreRequest
 
CoreResponse - Class in com.blockchyp.client.dto
Models elements almost all API responses have in common.
CoreResponse() - Constructor for class com.blockchyp.client.dto.CoreResponse
 
CryptoUtils - Class in com.blockchyp.client.crypto
This is utility class providing cryptography support for the BlockChyp client.

D

debug(Object) - Method in interface com.blockchyp.client.PaymentLogger
Logs the message at the debug log level.
debug(Object, Throwable) - Method in interface com.blockchyp.client.PaymentLogger
Logs the message and throwable at the debug log level.
debug(Object) - Method in class com.blockchyp.client.SystemOutPaymentLogger
 
debug(Object, Throwable) - Method in class com.blockchyp.client.SystemOutPaymentLogger
 
decrypt(APICredentials) - Method in class com.blockchyp.client.BlockChypClient
Decrypts API credentials using the offline cache key.
decrypt(String, byte[]) - Method in class com.blockchyp.client.crypto.CryptoUtils
Decrypts cipher text previously encoded with encrypt.
deriveOfflineKey() - Method in class com.blockchyp.client.BlockChypClient
Generates the encryption key used for offline cache records.
dumpSignatureFile(PaymentRequest, AuthorizationResponse) - Method in class com.blockchyp.client.BlockChypClient
Writes the signature to a file if a signature is present and the caller has requested it.

E

encrypt(APICredentials) - Method in class com.blockchyp.client.BlockChypClient
Encrypts API credentials using the offline cache key.
encrypt(String, byte[]) - Method in class com.blockchyp.client.crypto.CryptoUtils
Encrypts the given plain text using the given key using AES with PKCS#5 padding.
enroll(AuthorizationRequest) - Method in class com.blockchyp.client.BlockChypClient
Enrolls the payment method in the recurring payment token vault.
error(Object) - Method in interface com.blockchyp.client.PaymentLogger
Logs the message at the error log level.
error(Object, Throwable) - Method in interface com.blockchyp.client.PaymentLogger
Logs the message and throwable at the error log level.
error(Object) - Method in class com.blockchyp.client.SystemOutPaymentLogger
 
error(Object, Throwable) - Method in class com.blockchyp.client.SystemOutPaymentLogger
 

F

fatal(Object) - Method in interface com.blockchyp.client.PaymentLogger
Logs the message at the fatal log level.
fatal(Object, Throwable) - Method in interface com.blockchyp.client.PaymentLogger
Logs the message and throwable at the fatal log level.
fatal(Object) - Method in class com.blockchyp.client.SystemOutPaymentLogger
 
fatal(Object, Throwable) - Method in class com.blockchyp.client.SystemOutPaymentLogger
 
finishGatewayRequest(HttpMethod, Class) - Method in class com.blockchyp.client.BlockChypClient
Executes a previously assembled HttpMethod against the gateway.
finishTerminalRequest(TerminalRouteResponse, Object, EntityEnclosingMethod, Class) - Method in class com.blockchyp.client.BlockChypClient
This handles all the common logic associated with processing terminal http requests.

G

generateApiHeaders(String, String, String) - Method in class com.blockchyp.client.crypto.CryptoUtils
Generates the big three API request headers based on the input credentials.
generateTimestamp() - Method in class com.blockchyp.client.crypto.CryptoUtils
Generates a timestamp encoded for use in Gateway API request headers.
getAddress() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets the address for use with address verification.
getAid() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Returns the EMV application identifier.
getAltCurrency() - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Returns alternate currency code, if relevant.
getAltPrices() - Method in class com.blockchyp.client.dto.AuthorizationRequest
Returns a map of alternate currencies to their prices in each currency.
getAmount() - Method in class com.blockchyp.client.dto.AmountRequest
Returns the transaction amount.
getAmount() - Method in class com.blockchyp.client.dto.TransactionDisplayDiscount
Returns the discount amount.
getApiKey() - Method in class com.blockchyp.client.dto.APICredentials
Returns the API key.
getApiKey() - Method in class com.blockchyp.client.dto.TerminalRequest
Returns the API key.
getApplicationLabel() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Returns the application label.
getArc() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Gets the EMV authorization response code (Tag 8A).
getArqc() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Gets the ARQC, the application request cryptogram.
getAuthCode() - Method in class com.blockchyp.client.dto.ApprovalResponse
Returns the auth code from the payment network.
getAuthorizedAmount() - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Returns the authorized amount.
getAuthorizedAmount() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Returns the amount authorized by the network.
getBatchId() - Method in class com.blockchyp.client.dto.CoreResponse
Returns the batch id assigned to the transaction.
getBearerToken() - Method in class com.blockchyp.client.dto.APICredentials
Returns the bearer token.
getBearerToken() - Method in class com.blockchyp.client.dto.TerminalRequest
Returns the bearer token.
getCapturedTotal() - Method in class com.blockchyp.client.dto.CloseBatchResponse
Returns the total captured amount for the batch.
getCardBrands() - Method in class com.blockchyp.client.dto.CloseBatchResponse
Returns captured totals by card brand.
getCardHolder() - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Returns cardholder name.
getCardHolder() - Method in class com.blockchyp.client.dto.VoidRequest
Returns cardholder name.
getCardholderName() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets the cardholder name for use with PAN based transaction authorization.
getClockchain() - Method in class com.blockchyp.client.dto.HeartbeatResponse
Gets the public key of the clockchain.
getCurrencyCode() - Method in class com.blockchyp.client.dto.AmountRequest
Returns the currency code.
getCurrencyCode() - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Returns the currency code.
getCurrencyCode() - Method in class com.blockchyp.client.dto.CloseBatchResponse
Returns the currency code for this batch.
getCurve() - Method in class com.blockchyp.client.dto.RawPublicKey
Returns the name of the standard curve.
getCurve() - Method in class com.blockchyp.client.dto.RawSignature
Returns the name of the standard curve.
getCvv() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets the CVV for use with PAN based transaction authorization.
getDescription() - Method in class com.blockchyp.client.dto.AuthorizationRequest
Returns the transaction description.
getDescription() - Method in class com.blockchyp.client.dto.TransactionDisplayDiscount
Returns the discount description.
getDescription() - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Returns the line item description.
getDestinationAccount() - Method in class com.blockchyp.client.dto.CoreRequest
Returns the settlement account id.
getDiscounts() - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Returns the discounts associated with the line item.
getEntryMethod() - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Returns the entry method for a transaction.
getEntryMethod() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Returns the entry method for a transaction.
getEntryMethod() - Method in class com.blockchyp.client.dto.VoidRequest
Returns the entry method for a transaction.
getError() - Method in class com.blockchyp.client.dto.Acknowledgement
Gets a narrative description of the error, if any.
getExpMonth() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets the card expiration month for use with PAN based transaction authorization.
getExpYear() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets the card expiration year for use with PAN based transaction authorization.
getExtended() - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Gets the extended price for a line item.
getGateway(String, boolean, Class) - Method in class com.blockchyp.client.BlockChypClient
Executes an http get request against the gateway with a timeout override.
getGateway(String, boolean, Class, int) - Method in class com.blockchyp.client.BlockChypClient
Executes an http get request against the gateway with a timeout override.
getGatewayClient() - Method in class com.blockchyp.client.BlockChypClient
Returns the gateway client singleton.
getIad() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Returns EMV issuer application data, a mysterious value the card issuer sends with every EMV transaction.
getId() - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Returns the line item id.
getInstance() - Static method in class com.blockchyp.client.crypto.CryptoUtils
Returns the CryptoUtils singleton.
getIpAddress() - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Returns the current local IP address of the terminal on its local subnet.
getItems() - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Returns the line items associated with the transaction.
getLatestTick() - Method in class com.blockchyp.client.dto.HeartbeatResponse
Gets the hash of the latest tick block on the clockchain.
getMaskedPan() - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Returns the masked version of the PAN.
getMaskedPan() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Gets the masked PAN.
getMaskedPan() - Method in class com.blockchyp.client.dto.VoidRequest
Returns the masked version of the PAN.
getMerchantKey() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Returns a partially masked merchant key in order to ensure compliance with EMV receipt requirements.
getMerchantName() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Returns the name of the merchant.
getMerchantPk() - Method in class com.blockchyp.client.dto.HeartbeatResponse
Gets the public key for the merchant's blockchain.
getMessage() - Method in class com.blockchyp.client.dto.MessageRequest
Returns the message to be displayed on the terminal.
getNoCaption() - Method in class com.blockchyp.client.dto.BooleanPromptRequest
Gets the preferred caption for the 'no' button.
getOfflineCache(String) - Method in class com.blockchyp.client.BlockChypClient
Returns the route stored in the offline cache for the given terminal.
getOfflineRouteCacheLocation() - Method in class com.blockchyp.client.BlockChypClient
Returns the offline route cache location.
getOpenPreauths() - Method in class com.blockchyp.client.dto.CloseBatchResponse
Returns the total of preauths opened for this batch that were not captured.
getPan() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets the primary account number (PAN).
getPaymentType() - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Returns the payment type.
getPaymentType() - Method in class com.blockchyp.client.dto.VoidRequest
Returns the payment type.
getPostalCode() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets the postal code for use with address verification.
getPrice() - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Returns the undiscounted price per unit quantity.
getPrompt() - Method in class com.blockchyp.client.dto.BooleanPromptRequest
Returns the text to be displayed on the terminal.
getPromptType() - Method in class com.blockchyp.client.dto.TextPromptRequest
Gets the prompt type.
getPublicKey() - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Returns the blockchain public key if the user presented a BlockChyp payment card.
getPublicKey() - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Gets the public key of the terminal.
getPublicKey() - Method in class com.blockchyp.client.dto.VoidRequest
Returns the blockchain public key if the user presented a BlockChyp payment card.
getQuantity() - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Returns the line item quantity.
getR() - Method in class com.blockchyp.client.dto.RawSignature
Returns the signature's 'R' parameter as hex.
getRawKey() - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Gets the raw public key of the terminal.
getReceiptSuggestions() - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Returns receipt suggestions.
getReceiptSuggestions() - Method in class com.blockchyp.client.dto.VoidRequest
Returns receipt suggestions.
getRequest() - Method in class com.blockchyp.client.dto.TerminalRequest
Returns the underlying request object.
getRequestedAmount() - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Returns the requested amount.
getResponse() - Method in class com.blockchyp.client.dto.TextPromptResponse
Returns the text prompt response.
getResponseDescription() - Method in class com.blockchyp.client.dto.CoreResponse
Returns the response description.
getRoutingNumber() - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the ACH routing number if this is an ACH transaction.
getS() - Method in class com.blockchyp.client.dto.RawSignature
Returns the signature's 'S' parameter as hex.
getSig() - Method in class com.blockchyp.client.dto.CoreResponse
Returns the ECC signature of the response.
getSigFile() - Method in class com.blockchyp.client.dto.ApprovalResponse
Returns the sig file data if requested.
getSigFile() - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the desired output location of a signature image file, if there is one.
getSigFormat() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets the preferred output format for signature images.
getSigningKey() - Method in class com.blockchyp.client.dto.APICredentials
Returns the signing key.
getSigningKey() - Method in class com.blockchyp.client.dto.TerminalRequest
Returns the signing key.
getSigWidth() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets the maximum width of the signature image in pixels.
getSubtotal() - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Gets the pre tax subtotal for the line item display.
getTax() - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Returns tax for the line item display.
getTaxAmount() - Method in class com.blockchyp.client.dto.AmountRequest
Returns the tax amount.
getTaxAmount() - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Returns tax amount.
getTc() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Gets the EMV transaction certificate.
getTerminalClient() - Method in class com.blockchyp.client.BlockChypClient
Returns the terminal client singleton.
getTerminalId() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Returns the terminal id.
getTerminalName() - Method in class com.blockchyp.client.dto.BooleanPromptRequest
Returns the name of the target payment terminal.
getTerminalName() - Method in class com.blockchyp.client.dto.ClearTerminalRequest
Returns the name of the target payment terminal.
getTerminalName() - Method in interface com.blockchyp.client.dto.ITerminalReference
Returns the name of a payment terminal.
getTerminalName() - Method in class com.blockchyp.client.dto.MessageRequest
Returns the target terminal name.
getTerminalName() - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the target terminal name to which the transaction will be routed.
getTerminalName() - Method in class com.blockchyp.client.dto.PingRequest
Returns the name of the target payment terminal.
getTerminalName() - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Echoes back the terminal name for the route lookup.
getTerminalName() - Method in class com.blockchyp.client.dto.TextPromptRequest
Returns the target terminal name.
getTerminalName() - Method in class com.blockchyp.client.dto.TransactionDisplayRequest
Returns the target terminal name.
getTickBlock() - Method in class com.blockchyp.client.dto.CoreResponse
Returns the last tick block hash.
getTimeout() - Method in class com.blockchyp.client.dto.CoreRequest
Returns the request timeout.
getTimestamp() - Method in class com.blockchyp.client.dto.CloseBatchResponse
Returns the timestamp on the server at the time the heartbeat request was processed.
getTimestamp() - Method in class com.blockchyp.client.dto.CoreResponse
Returns the timestamp on the server at the time the heartbeat request was processed.
getTimestamp() - Method in class com.blockchyp.client.dto.HeartbeatResponse
Returns the timestamp on the server at the time the heartbeat request was processed.
getTimestamp() - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Gets the timestamp associated with the route request.
getTipAmount() - Method in class com.blockchyp.client.dto.AmountRequest
Returns the tip amount.
getTipAmount() - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Returns the tip amount.
getToken() - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Sets the token if the transaction was an enrolling transaction.
getToken() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets the payment token to be used with this transaction.
getToken() - Method in class com.blockchyp.client.dto.VoidRequest
Gets the token if the transaction was an enrolling transaction.
getTotal() - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Returns grand total for the line item display.
getTrack1() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets track 1 data.
getTrack2() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets track 2 data.
getTransaction() - Method in class com.blockchyp.client.dto.TransactionDisplayRequest
Returns the transaction to be displayed on the terminal.
getTransactionId() - Method in class com.blockchyp.client.dto.CaptureRequest
Returns the transaction id being captured.
getTransactionId() - Method in class com.blockchyp.client.dto.CoreResponse
Returns the transaction id assigned to the transaction.
getTransactionId() - Method in class com.blockchyp.client.dto.RefundRequest
Gets the id of the transaction being refunded.
getTransactionId() - Method in class com.blockchyp.client.dto.VoidRequest
Returns the transaction id being captured.
getTransactionRef() - Method in class com.blockchyp.client.dto.CoreRequest
Returns the transaction ref value.
getTransactionRef() - Method in class com.blockchyp.client.dto.CoreResponse
Echoes back the transaction ref from the original request.
getTransactionType() - Method in class com.blockchyp.client.dto.CoreResponse
Echoes back the transaction type from the original request.
getTransactionType() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Returns the transaction type.
getTransientCredentials() - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Gets transient credentials to be used with the terminal route.
getTsi() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Returns the EMV Transaction Status Information Tag (Tag 9B).
getX() - Method in class com.blockchyp.client.dto.RawPublicKey
Returns the X coordinate as hex.
getY() - Method in class com.blockchyp.client.dto.RawPublicKey
Returns the Y coordinate as hex.
getYesCaption() - Method in class com.blockchyp.client.dto.BooleanPromptRequest
Gets the preferred caption for the 'yes' button.

H

HEADER_AUTHORIZATION - Static variable in class com.blockchyp.client.crypto.CryptoUtils
 
HEADER_NONCE - Static variable in class com.blockchyp.client.crypto.CryptoUtils
 
HEADER_TIMESTAMP - Static variable in class com.blockchyp.client.crypto.CryptoUtils
 
heartbeat(boolean) - Method in class com.blockchyp.client.BlockChypClient
Tests communication with the Gateway.
HeartbeatResponse - Class in com.blockchyp.client.dto
This class models heartbeat responses.
HeartbeatResponse() - Constructor for class com.blockchyp.client.dto.HeartbeatResponse
 

I

info(Object) - Method in interface com.blockchyp.client.PaymentLogger
Logs the message at the info log level.
info(Object, Throwable) - Method in interface com.blockchyp.client.PaymentLogger
Logs the message and throwable at the info log level.
info(Object) - Method in class com.blockchyp.client.SystemOutPaymentLogger
 
info(Object, Throwable) - Method in class com.blockchyp.client.SystemOutPaymentLogger
 
initObjectMapper() - Method in class com.blockchyp.client.BlockChypClient
Initializes the JSON encoder and parser.
isApproved() - Method in class com.blockchyp.client.dto.ApprovalResponse
Returns the approved flag.
isCloudRelayEnabled() - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Returns the cloud relay flag.
isEnroll() - Method in class com.blockchyp.client.dto.AuthorizationRequest
Returns the enroll flag.
isExists() - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Gets the exists flag.
isManualEntry() - Method in class com.blockchyp.client.dto.PaymentRequest
Gets manual entry mode.
isPartialAuth() - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Returns true if this was a partial authorization.
isPromptForTip() - Method in class com.blockchyp.client.dto.AuthorizationRequest
Returns the prompt for tip flag.
isRequestSignature() - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Gets the request signature flag.
isResponse() - Method in class com.blockchyp.client.dto.BooleanPromptResponse
Gets the boolean prompt response.
isScopeAlert() - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Returns true if the transaction did something that would put the system in PCI scope.
isScopeAlert() - Method in class com.blockchyp.client.dto.VoidRequest
Returns true if the transaction did something that would put the system in PCI scope.
isStoreAndForward() - Method in class com.blockchyp.client.dto.AuthorizationResponse
Gets the store and forward flag.
isSuccess() - Method in class com.blockchyp.client.dto.Acknowledgement
Gets the success flag.
isSuccess() - Method in class com.blockchyp.client.dto.CloseBatchResponse
Returns the success flag.
isTaxExempt() - Method in class com.blockchyp.client.dto.AmountRequest
Returns the tax exempt flag.
isTerminalHttps() - Method in class com.blockchyp.client.BlockChypClient
Gets the terminal https flag.
isTerminalRouted(ITerminalReference) - Method in class com.blockchyp.client.BlockChypClient
Returns true if transaction for the given terminal reference should be routed over the local subnet.
isTest() - Method in class com.blockchyp.client.dto.CoreRequest
Sets the transaction test flag.
isTest() - Method in class com.blockchyp.client.dto.CoreResponse
Echoes back the test flag set on the original request.
ITerminalReference - Interface in com.blockchyp.client.dto
Common abstraction for DTO's with terminal references.

M

message(MessageRequest) - Method in class com.blockchyp.client.BlockChypClient
Displays a text message on the terminal screen.
MessageRequest - Class in com.blockchyp.client.dto
Models the settings needed to display a message on the screen.
MessageRequest() - Constructor for class com.blockchyp.client.dto.MessageRequest
 
MS_PER_HOUR - Static variable in class com.blockchyp.client.BlockChypClient
 

N

newTerminalRequestForRoute(TerminalRouteResponse) - Method in class com.blockchyp.client.BlockChypClient
Assembles a new terminal request and populates the credentials, using transient credentials if available.
newTransactionDisplay(TransactionDisplayRequest) - Method in class com.blockchyp.client.BlockChypClient
Resets the line item display.
NONCE_SIZE_IN_BYTES - Static variable in class com.blockchyp.client.crypto.CryptoUtils
 

O

OFFLINE_CACHE - Static variable in class com.blockchyp.client.BlockChypClient
 
OFFLINE_FIXED_KEY - Static variable in class com.blockchyp.client.BlockChypClient
 

P

PaymentLogger - Interface in com.blockchyp.client
This is a simple logging abstraction following the conventions from Jakarta commons-logging.
PaymentRequest - Class in com.blockchyp.client.dto
Models requests that include payment method information.
PaymentRequest() - Constructor for class com.blockchyp.client.dto.PaymentRequest
 
ping(PingRequest) - Method in class com.blockchyp.client.BlockChypClient
Tests local communication with a terminal.
PingRequest - Class in com.blockchyp.client.dto
Models a ping request to test connectivity with a terminal.
PingRequest() - Constructor for class com.blockchyp.client.dto.PingRequest
 
populateSignatureOptions(PaymentRequest) - Method in class com.blockchyp.client.BlockChypClient
This method is used to setup sensible defaults for local signature file dumps.
postGateway(String, CoreRequest, Class) - Method in class com.blockchyp.client.BlockChypClient
Executes a post HTTP request against the gateway.
postTerminal(String, Object, Class) - Method in class com.blockchyp.client.BlockChypClient
Posts an http request to the terminal API.
preauth(AuthorizationRequest) - Method in class com.blockchyp.client.BlockChypClient
Preauthorizes a transaction.
putGateway(String, CoreRequest, Class) - Method in class com.blockchyp.client.BlockChypClient
Executes a put HTTP request against the gateway.
putTerminal(String, Object, Class) - Method in class com.blockchyp.client.BlockChypClient
Executes a put http request against the terminal API.

R

randomBytes(int) - Method in class com.blockchyp.client.crypto.CryptoUtils
Returns an array of random bytes of the given length.
RawPublicKey - Class in com.blockchyp.client.dto
This class models the raw parameters of an elliptic curve public key.
RawPublicKey() - Constructor for class com.blockchyp.client.dto.RawPublicKey
 
RawSignature - Class in com.blockchyp.client.dto
This class models the raw parameters of an elliptic curve signature.
RawSignature() - Constructor for class com.blockchyp.client.dto.RawSignature
 
ReceiptSuggestions - Class in com.blockchyp.client.dto
This class models information we recommend you put on your receipts.
ReceiptSuggestions() - Constructor for class com.blockchyp.client.dto.ReceiptSuggestions
 
refund(RefundRequest) - Method in class com.blockchyp.client.BlockChypClient
Refunds a transaction.
RefundRequest - Class in com.blockchyp.client.dto
This class models information needed to process refunds.
RefundRequest() - Constructor for class com.blockchyp.client.dto.RefundRequest
 
resolveOfflineRouteCacheLocation(String) - Method in class com.blockchyp.client.BlockChypClient
Returns the offline cache location.
resolveTerminalHost(TerminalRouteResponse) - Method in class com.blockchyp.client.BlockChypClient
Assembles the scheme, ip address, and port number bits of a terminal URL.
resolveTerminalRoute(String) - Method in class com.blockchyp.client.BlockChypClient
Finds the terminal route record for the given terminal name.
reverse(AuthorizationRequest) - Method in class com.blockchyp.client.BlockChypClient
Executes a time out reversal.
routeCacheGet(String) - Method in class com.blockchyp.client.BlockChypClient
Looks up a terminal route from the cache.
routeCachePut(TerminalRouteResponse) - Method in class com.blockchyp.client.BlockChypClient
Puts a terminal route in the cache (both caches).

S

setAddress(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the address for use with address verification.
setAid(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the EMV application identifier.
setAltCurrency(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Sets alternate currency code if selected by the consumer.
setAltPrices(Map) - Method in class com.blockchyp.client.dto.AuthorizationRequest
A Map<String, String> that maps alternate currencies to their prices in each currency.
setAmount(String) - Method in class com.blockchyp.client.dto.AmountRequest
Sets the requested transaction amount.
setAmount(String) - Method in class com.blockchyp.client.dto.TransactionDisplayDiscount
Sets the discount amount.
setApiKey(String) - Method in class com.blockchyp.client.dto.APICredentials
Sets the API key.
setApiKey(String) - Method in class com.blockchyp.client.dto.TerminalRequest
Sets the API key.
setApplicationLabel(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the application label.
setApproved(boolean) - Method in class com.blockchyp.client.dto.ApprovalResponse
Sets the approved flag.
setArc(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets EMV authorization response Code.
setArqc(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the ARQC.
setAuthCode(String) - Method in class com.blockchyp.client.dto.ApprovalResponse
Sets the auth code from the payment network.
setAuthorizedAmount(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Sets the authorized amount.
setAuthorizedAmount(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the authorized amount as a localized string.
setBatchId(String) - Method in class com.blockchyp.client.dto.CoreResponse
Sets the batch id.
setBearerToken(String) - Method in class com.blockchyp.client.dto.APICredentials
Sets the bearer token.
setBearerToken(String) - Method in class com.blockchyp.client.dto.TerminalRequest
Sets the bearer token.
setCapturedTotal(String) - Method in class com.blockchyp.client.dto.CloseBatchResponse
Sets the captured total.
setCardBrands(Map) - Method in class com.blockchyp.client.dto.CloseBatchResponse
Sets captured totals by card brands map.
setCardHolder(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Sets cardholder name.
setCardHolder(String) - Method in class com.blockchyp.client.dto.VoidRequest
Sets cardholder name.
setCardholderName(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the cardholder name for use with PAN based transaction authorization.
setClockchain(String) - Method in class com.blockchyp.client.dto.HeartbeatResponse
Sets the public key of the clockchain.
setCloudRelayEnabled(boolean) - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Sets the cloud relay flag.
setCurrencyCode(String) - Method in class com.blockchyp.client.dto.AmountRequest
Sets the currency code.
setCurrencyCode(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Sets the currency code.
setCurrencyCode(String) - Method in class com.blockchyp.client.dto.CloseBatchResponse
Sets the currency code.
setCurve(String) - Method in class com.blockchyp.client.dto.RawPublicKey
Sets the name of the standard curve.
setCurve(String) - Method in class com.blockchyp.client.dto.RawSignature
Sets the name of the standard curve.
setCvv(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the CVV for use with PAN based transaction authorization.
setDefaultCredentials(APICredentials) - Method in class com.blockchyp.client.BlockChypClient
Sets the default root API credentials for the client.
setDescription(String) - Method in class com.blockchyp.client.dto.AuthorizationRequest
Sets the transaction description.
setDescription(String) - Method in class com.blockchyp.client.dto.TransactionDisplayDiscount
Sets the discount description.
setDescription(String) - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Sets the line item description.
setDestinationAccount(String) - Method in class com.blockchyp.client.dto.CoreRequest
Sets the settlement account for merchants with split settlement enabled (not common).
setDiscounts(Collection) - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Sets the discounts on the line item.
setEnroll(boolean) - Method in class com.blockchyp.client.dto.AuthorizationRequest
Sets the enroll flag.
setEntryMethod(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Sets the entry method for the transactions.
setEntryMethod(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the entry method for the transactions.
setEntryMethod(String) - Method in class com.blockchyp.client.dto.VoidRequest
Sets the entry method for the transactions.
setError(String) - Method in class com.blockchyp.client.dto.Acknowledgement
Sets a narrative description of the error, if any.
setExists(boolean) - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Sets the exists flag.
setExpMonth(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the card expiration month for use with PAN based transaction authorization.
setExpYear(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the card expiration year for use with PAN based transaction authorization.
setExtended(String) - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Sets the extended price.
setGatewayHost(String) - Method in class com.blockchyp.client.BlockChypClient
Used to override the live gateway host.
setIad(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the Issuer Application Data tag.
setId(String) - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Sets the line item id.
setIpAddress(String) - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Sets the local IP address.
setItems(Collection) - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Sets the line items on the transaction.
setLatestTick(String) - Method in class com.blockchyp.client.dto.HeartbeatResponse
Sets the hash of the latest tick block on the clockchain.
setManualEntry(boolean) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets manual entry mode.
setMaskedPan(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Sets the masked version of the PAN.
setMaskedPan(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the masked primary account number.
setMaskedPan(String) - Method in class com.blockchyp.client.dto.VoidRequest
Sets the masked version of the PAN.
setMerchantKey(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the merchant key.
setMerchantName(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the merchant name.
setMerchantPk(String) - Method in class com.blockchyp.client.dto.HeartbeatResponse
Sets the public key of the merchant's blockchain.
setMessage(String) - Method in class com.blockchyp.client.dto.MessageRequest
Sets the message to be displayed on the terminal.
setNoCaption(String) - Method in class com.blockchyp.client.dto.BooleanPromptRequest
Sets the preferred caption for the 'no' button.
setOfflineRouteCacheEnabled(boolean) - Method in class com.blockchyp.client.BlockChypClient
Enables or disables offline terminal route caching.
setOfflineRouteCacheLocation(String) - Method in class com.blockchyp.client.BlockChypClient
Sets the offline route cache location if you want to override the default.
setOpenPreauths(String) - Method in class com.blockchyp.client.dto.CloseBatchResponse
Sets the open preauth total.
setPan(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the primary account number (PAN).
setPartialAuth(boolean) - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Sets the partial auth flag.
setPaymentLogger(PaymentLogger) - Method in class com.blockchyp.client.BlockChypClient
Sets the payment logger.
setPaymentType(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Sets the payment type.
setPaymentType(String) - Method in class com.blockchyp.client.dto.VoidRequest
Sets the payment type.
setPostalCode(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the postal code for use with address verification.
setPrice(String) - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Sets the undiscounted price per unit quantity.
setPrompt(String) - Method in class com.blockchyp.client.dto.BooleanPromptRequest
Sets the text to be displayed on the terminal.
setPromptForTip(boolean) - Method in class com.blockchyp.client.dto.AuthorizationRequest
Sets the prompt for tip flag.
setPromptType(String) - Method in class com.blockchyp.client.dto.TextPromptRequest
Sets the type of prompt.
setPublicKey(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Sets the payment method public key, if it's a blockchain method.
setPublicKey(String) - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Sets the compressed public key for the terminal.
setPublicKey(String) - Method in class com.blockchyp.client.dto.VoidRequest
Sets the payment method public key, if it's a blockchain method.
setQuantity(float) - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Sets the line item quantity.
setR(String) - Method in class com.blockchyp.client.dto.RawSignature
Sets the signature's 'R' parameter as hex.
setRawKey(RawPublicKey) - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Sets the raw public key of the terminal.
setReceiptSuggestions(ReceiptSuggestions) - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Sets receipt suggestions.
setReceiptSuggestions(ReceiptSuggestions) - Method in class com.blockchyp.client.dto.VoidRequest
Sets receipt suggestions.
setRequest(Object) - Method in class com.blockchyp.client.dto.TerminalRequest
Sets the underlying request.
setRequestedAmount(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Sets the requested amount.
setRequestSignature(boolean) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the request signature flag.
setResponse(boolean) - Method in class com.blockchyp.client.dto.BooleanPromptResponse
Sets the boolean prompt response.
setResponse(String) - Method in class com.blockchyp.client.dto.TextPromptResponse
Sets the text prompt response.
setResponseDescription(String) - Method in class com.blockchyp.client.dto.CoreResponse
Sets the response description.
setRoutingNumber(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the ACH routing number if this is an ACH transaction.
setS(String) - Method in class com.blockchyp.client.dto.RawSignature
Sets the signature's 'S' parameter as hex.
setScopeAlert(boolean) - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Sets the scope alert flag.
setScopeAlert(boolean) - Method in class com.blockchyp.client.dto.VoidRequest
Sets the scope alert flag.
setSig(String) - Method in class com.blockchyp.client.dto.CoreResponse
Sets the response signature.
setSigFile(String) - Method in class com.blockchyp.client.dto.ApprovalResponse
Sets the signature file hex.
setSigFile(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the desired output location of a signature image file, if there is one.
setSigFormat(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the preferred output format for signature images.
setSigningKey(String) - Method in class com.blockchyp.client.dto.APICredentials
Sets the signing key.
setSigningKey(String) - Method in class com.blockchyp.client.dto.TerminalRequest
Sets the signing key.
setSigWidth(int) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the maximum width of the signature image in pixels.
setStoreAndForward(boolean) - Method in class com.blockchyp.client.dto.AuthorizationResponse
Sets the store and forward flag.
setSubtotal(String) - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Sets the pre tax subtotal for the line item display.
setSuccess(boolean) - Method in class com.blockchyp.client.dto.Acknowledgement
Sets the success flag.
setSuccess(boolean) - Method in class com.blockchyp.client.dto.CloseBatchResponse
Sets the success flag.
setTax(String) - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Sets tax for the line item display.
setTaxAmount(String) - Method in class com.blockchyp.client.dto.AmountRequest
Sets tax amount.
setTaxAmount(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Sets the tax amount.
setTaxExempt(boolean) - Method in class com.blockchyp.client.dto.AmountRequest
Sets the tax exempt flag.
setTc(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the EMV transaction certificate.
setTerminalHttps(boolean) - Method in class com.blockchyp.client.BlockChypClient
Sets the terminal https flag.
setTerminalId(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the terminal identifier.
setTerminalName(String) - Method in class com.blockchyp.client.dto.BooleanPromptRequest
Sets the target payment terminal.
setTerminalName(String) - Method in class com.blockchyp.client.dto.ClearTerminalRequest
Sets the target payment terminal.
setTerminalName(String) - Method in class com.blockchyp.client.dto.MessageRequest
Sets the target terminal name.
setTerminalName(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the target terminal name to which the transaction will be routed.
setTerminalName(String) - Method in class com.blockchyp.client.dto.PingRequest
Sets the target payment terminal.
setTerminalName(String) - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Sets the terminal name.
setTerminalName(String) - Method in class com.blockchyp.client.dto.TextPromptRequest
Sets the target terminal name.
setTerminalName(String) - Method in class com.blockchyp.client.dto.TransactionDisplayRequest
Sets the target terminal name.
setTest(boolean) - Method in class com.blockchyp.client.dto.CoreRequest
Sets the test transaction flag.
setTest(boolean) - Method in class com.blockchyp.client.dto.CoreResponse
Sets the test flag.
setTestGatewayHost(String) - Method in class com.blockchyp.client.BlockChypClient
Used to override the test gateway host.
setTickBlock(String) - Method in class com.blockchyp.client.dto.CoreResponse
Hash of the latest tick block.
setTimeout(int) - Method in class com.blockchyp.client.dto.CoreRequest
Sets the request timeout.
setTimestamp(Date) - Method in class com.blockchyp.client.dto.CloseBatchResponse
Sets the timestamp.
setTimestamp(String) - Method in class com.blockchyp.client.dto.CoreResponse
Sets the timestamp.
setTimestamp(Date) - Method in class com.blockchyp.client.dto.HeartbeatResponse
Sets the timestamp.
setTimestamp(Date) - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Sets the timestamp associated with the route request.
setTipAmount(String) - Method in class com.blockchyp.client.dto.AmountRequest
Sets the tip amount, if there is one.
setTipAmount(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithAmounts
Sets the tip amount.
setToken(String) - Method in class com.blockchyp.client.dto.ApprovalResponseWithPaymentMethod
Sets the token if the transaction was an enrolling transaction.
setToken(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets the payment token to be used with this transaction.
setToken(String) - Method in class com.blockchyp.client.dto.VoidRequest
Sets the token if the transaction was an enrolling transaction.
setTotal(String) - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Sets the grand total on the line item display.
setTrack1(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets track 1 data.
setTrack2(String) - Method in class com.blockchyp.client.dto.PaymentRequest
Sets track 2 data.
setTransaction(TransactionDisplayTransaction) - Method in class com.blockchyp.client.dto.TransactionDisplayRequest
Sets the transaction to be displayed on the terminal.
setTransactionId(String) - Method in class com.blockchyp.client.dto.CaptureRequest
Sets the transaction id for the previous transaction being captured.
setTransactionId(String) - Method in class com.blockchyp.client.dto.CoreResponse
Sets the transaction id.
setTransactionId(String) - Method in class com.blockchyp.client.dto.RefundRequest
Sets the id of the transaction being refunded.
setTransactionId(String) - Method in class com.blockchyp.client.dto.VoidRequest
Sets the transaction id for the previous transaction being captured.
setTransactionRef(String) - Method in class com.blockchyp.client.dto.CoreRequest
Sets the transaction ref value.
setTransactionRef(String) - Method in class com.blockchyp.client.dto.CoreResponse
Sets the transaction ref.
setTransactionType(String) - Method in class com.blockchyp.client.dto.CoreResponse
Sets the transaction type.
setTransactionType(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the transaction type.
setTransientCredentials(APICredentials) - Method in class com.blockchyp.client.dto.TerminalRouteResponse
Sets transient credentials to be used with the terminal route.
setTsi(String) - Method in class com.blockchyp.client.dto.ReceiptSuggestions
Sets the EMV transaction status information tag.
setX(String) - Method in class com.blockchyp.client.dto.RawPublicKey
Sets the X coordinate in hex.
setY(String) - Method in class com.blockchyp.client.dto.RawPublicKey
Sets the Y coordinate in hex.
setYesCaption(String) - Method in class com.blockchyp.client.dto.BooleanPromptRequest
Sets the preferred caption for the 'yes' button.
SystemOutPaymentLogger - Class in com.blockchyp.client
Very minimal implementation of PaymentLogger.
SystemOutPaymentLogger() - Constructor for class com.blockchyp.client.SystemOutPaymentLogger
 

T

TerminalRequest - Class in com.blockchyp.client.dto
This class is used to wrap conventional transaction requests with an outer structure that adds API credentials.
TerminalRequest() - Constructor for class com.blockchyp.client.dto.TerminalRequest
 
TerminalRouteResponse - Class in com.blockchyp.client.dto
Models metadata about a terminal route, including it's location on the local network and transient credentials.
TerminalRouteResponse() - Constructor for class com.blockchyp.client.dto.TerminalRouteResponse
 
textPrompt(TextPromptRequest) - Method in class com.blockchyp.client.BlockChypClient
Captures text input from the user.
TextPromptRequest - Class in com.blockchyp.client.dto
Models the information needed to call the text prompt API.
TextPromptRequest() - Constructor for class com.blockchyp.client.dto.TextPromptRequest
 
TextPromptResponse - Class in com.blockchyp.client.dto
Models results from a text prompt on the terminal.
TextPromptResponse() - Constructor for class com.blockchyp.client.dto.TextPromptResponse
 
toFullyQualifiedGatewayPath(String, boolean) - Method in class com.blockchyp.client.BlockChypClient
Converts path to the fully qualified URL for a gateway API call.
toFullyQualifiedTerminalPath(TerminalRouteResponse, String) - Method in class com.blockchyp.client.BlockChypClient
Assembles a full path to the terminal for an API call.
toTerminalRouteKey(String) - Method in class com.blockchyp.client.BlockChypClient
Creates a cache key for terminal routes.
TransactionDisplayDiscount - Class in com.blockchyp.client.dto
Models transaction discount information for the line item display.
TransactionDisplayDiscount() - Constructor for class com.blockchyp.client.dto.TransactionDisplayDiscount
 
TransactionDisplayItem - Class in com.blockchyp.client.dto
Models an individual item to be displayed on the terminal line item display.
TransactionDisplayItem() - Constructor for class com.blockchyp.client.dto.TransactionDisplayItem
 
TransactionDisplayRequest - Class in com.blockchyp.client.dto
This class models a request to update the transaction line item display on the terminal.
TransactionDisplayRequest() - Constructor for class com.blockchyp.client.dto.TransactionDisplayRequest
 
TransactionDisplayTransaction - Class in com.blockchyp.client.dto
Models a transaction to be displayed on the terminal line item display.
TransactionDisplayTransaction() - Constructor for class com.blockchyp.client.dto.TransactionDisplayTransaction
 

U

updateTransactionDisplay(TransactionDisplayRequest) - Method in class com.blockchyp.client.BlockChypClient
Updates the line item display.

V

VoidRequest - Class in com.blockchyp.client.dto
Voids a previous transaction in the current batch.
VoidRequest() - Constructor for class com.blockchyp.client.dto.VoidRequest
 
VoidResponse - Class in com.blockchyp.client.dto
Models response to a void transaction.
VoidResponse() - Constructor for class com.blockchyp.client.dto.VoidResponse
 
voidTx(VoidRequest) - Method in class com.blockchyp.client.BlockChypClient
Voids a transaction.

W

withDiscount(TransactionDisplayDiscount) - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Add a single discount to an existing line item.
withDiscounts(Collection) - Method in class com.blockchyp.client.dto.TransactionDisplayItem
Adds discounts to an existing line item.
withItem(TransactionDisplayItem) - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Add a single line item to an existing transaction for those developers who like the builder pattern.
withItems(Collection) - Method in class com.blockchyp.client.dto.TransactionDisplayTransaction
Sets the line items for the transaction using the builder pattern.
A B C D E F G H I M N O P R S T U V W 
Skip navigation links

Copyright © 2019 BlockChyp, Inc.. All rights reserved.