All Classes and Interfaces
Class
Description
A basic api acknowledgement.
Models a physical address.
Models basic information needed to create a test merchant.
Models low level aggregated and nested data line items.
Models statistics for low level aggregation line items.
Encapsulates the big three BlockChyp API credentials.
An authorization request for a charge, preauth, or reverse transaction.
The response to an authorization request.
A request for the remaining balance on a payment type.
The response to a balance request.
Models meta data about a merchant bank account.
Models a request for details about a single batch.
Models a response for details about a single batch.
Models a batch history request.
Models response to a batch history request.
Models high level information about a single batch.
This is the main class Java developers will interact with.
A simple yes no prompt request.
The response to a boolean prompt request.
Models the priority and display settings for terminal media.
Models a request to retrieve or manipulate terminal slide shows.
Models a branding asset response.
Models a single buy rate calculation line item.
Cancels a pending payment link.
Success or failure of a payment link cancellation.
The information needed to capture a preauth.
The response to a capture request.
A request for customer signature data.
Customer signature data.
Computes the cash discount for a cash discount if enabled.
Models the results of a cash discount calculation.
The information needed to enroll a new payment method in the token vault.
The information needed to manually close a credit card batch.
The response to a close batch request.
This is utility class providing cryptography support for the BlockChyp client.
Models a customer record.
Models a customer data request.
Models a customer data response.
Models a customer data search request.
Models customer search results.
Models a customer token.
Deletes a customer record.
The response to a delete customer request.
Deletes one or all transactions from a terminal queue.
The response to a delete queued transaction request.
Deletes a payment token.
The response to a delete token request.
The information needed to enroll a new payment method in the token vault.
The response to an enroll request.
Models a request for merchant information.
The results for a merchant list request.
The information needed to activate or recharge a gift card.
The response to a gift activate request.
Fields for HSA/FSA transactions.
A group of fields for a specific type of healthcare.
The response to a basic API health check.
Fields which should be returned with standard requests.
contains a basic api acknowledgement.
Response fields for an approved transaction.
Core request fields for a transaction.
Core response fields for a transaction.
Response details for a cryptocurrency transaction.
Models a request for adding a new user to a merchant account.
Models a single invoice or merchant statement line item.
Models information about payments against an invoice.
Response details about tender amounts.
Request details about a payment method.
Response details about a payment method.
A reference to a previous transaction.
Request details about tender amounts.
A request for customer signature data.
Customer signature data.
Request subtotals.
A reference to a terminal name.
Models a low level request with a timeout and test flag.
Links a payment token with a customer record.
Returns a list of queued transactions on a terminal.
A list of queued transactions on a terminal.
Information needed to retrieve location information for a terminal.
The response to a locate request.
Models a media library response.
Models a request to retrieve survey results.
Models a request to retrieve or manipulate media assets.
Models a request to retrieve detailed merchant invoice information.
Models detailed merchant invoice or statement information.
Models a request to retrieve a list of partner statements.
Models a response to an invoice list request.
Models basic information about a merchant invoice for use in list or search results.
Details about a merchant board platform configuration.
Models a request related to a platform configuration.
The results for a merchant platforms inquiry.
Models a merchant profile.
Models a request for information about the merchant profile.
Models a response for a single merchant profile.
Details about a merchant user.
The results for a merchant users list.
A message to be displayed on the terminal screen.
Models a request to retrieve detailed merchant invoice information.
Models detailed information about how partner commissions were calculated for a
statement.
Models partner statement adjustments.
Models a request to retrieve detailed partner statement information.
Models a response to retrieve detailed partner statement information.
Models details about disbursements related to partner statements.
Models line item level data for a partner statement.
Models a request to retrieve a list of partner statements.
Models results to a partner statement list inquiry.
Models a basic information about partner statements for use in list or search results.
Creates a payment link.
Creates a payment link.
Models the request for updated information about a payment link.
Models the status of a payment link.
This is a simple logging abstraction following the conventions from Jakarta
commons-logging.
Information needed to test connectivity with a terminal.
The response to a ping request.
Models a single set of pricing values for a pricing policy.
Models a request to retrieve pricing policy information.
Models a the response to a pricing policy request.
This class models the raw parameters of an elliptic curve public key.
This class models the raw parameters of an elliptic curve signature.
EMV fields we recommend developers put on their receipts.
A refund request.
Resends a pending payment link.
Success or failure of a payment link resend operation.
Models a slide within a slide show.
Models a media library response.
Models a request to retrieve or manipulate terminal slide shows.
Models a slide show response.
Models information about merchant deposits during a statement period.
Models a request to retrieve or manipulate survey questions.
Models a survey question.
Models a request to retrieve or manipulate survey questions.
Models a survey question response.
Models a request to retrieve survey results.
Very minimal implementation of PaymentLogger.
Models a terminal activation request.
Models a terminal deactivation request.
Details about a merchant board platform configuration.
Models a terminal profile request.
Models a terminal profile response.
This class is used to wrap conventional transaction requests with an outer structure that adds API credentials.
Models metadata about a terminal route, including it's location on the local network
and transient credentials.
A request for the status of a terminal.
The current status of a terminal.
Models transaction volume for a single terminal.
Models a Terms and Conditions log entry.
Models a Terms and Conditions history request.
Models a Terms and Conditions history request.
The fields needed for custom Terms and Conditions prompts.
A signature capture response for Terms and Conditions.
Models a full terms and conditions template.
Models a request to retrieve or manipulate terms and conditions data.
Models a set of templates responsive to a request.
A text prompt request.
The response to a text prompt request.
Retrieves token metadata.
Models a payment token metadata response.
An item level discount for transaction display.
An item category in a transaction display.
Used to start or update a transaction line item display on a terminal.
The items to display on a terminal.
Models a batch history request.
Models response to a batch history request.
Models the status of a transaction.
Models the request for updated information about a transaction.
Removes a link between a payment token with a customer record, if one exists.
Models a customer data search request.
Models information needed to process a file upload.
Models the current status of a file upload.
Used to request the status of a file upload.
A void request.
The response to a void request.
Shows details about a white listed card.