Package com.blockchyp.client.dto

Interface Summary

Interface	Description
IAbstractAcknowledgement	Fields which should be returned with standard requests.
IAcknowledgement	contains a basic api acknowledgement.
IApprovalResponse	Response fields for an approved transaction.
ICoreRequest	Core request fields for a transaction.
ICoreResponse	Core response fields for a transaction.
ICryptocurrencyResponse	Response details for a cryptocurrency transaction.
IPaymentAmounts	Response details about tender amounts.
IPaymentMethod	Request details about a payment method.
IPaymentMethodResponse	Response details about a payment method.
IPreviousTransaction	A reference to a previous transaction.
IRequestAmount	Request details about tender amounts.
ISignatureRequest	A request for customer signature data.
ISignatureResponse	Customer signature data.
ISubtotals	Request subtotals.
ITerminalReference	A reference to a terminal name.
ITimeoutRequest	Models a low level request with a timeout and test flag.

Class Summary

Class	Description
Acknowledgement	A basic api acknowledgement.
Address	Models a physical address.
AddTestMerchantRequest	Models basic information needed to create a test merchant.
AuthorizationRequest	An authorization request for a charge, preauth, or reverse transaction.
AuthorizationResponse	The response to an authorization request.
BalanceRequest	A request for the remaining balance on a payment type.
BalanceResponse	The response to a balance request.
BankAccount	Models meta data about a merchant bank account.
BatchDetailsRequest	Models a request for details about a single batch.
BatchDetailsResponse	Models a response for details about a single batch.
BatchHistoryRequest	Models a batch history request.
BatchHistoryResponse	Models response to a batch history request.
BatchSummary	Models high level information about a single batch.
BooleanPromptRequest	A simple yes no prompt request.
BooleanPromptResponse	The response to a boolean prompt request.
BrandingAsset	Models the priority and display settings for terminal media.
BrandingAssetRequest	Models a request to retrieve or manipulate terminal slide shows.
BrandingAssetResponse	Models a branding asset response.
CancelPaymentLinkRequest	Cancels a pending payment link.
CancelPaymentLinkResponse	Success or failure of a payment link cancellation.
CaptureRequest	The information needed to capture a preauth.
CaptureResponse	The response to a capture request.
CaptureSignatureRequest	A request for customer signature data.
CaptureSignatureResponse	Customer signature data.
CashDiscountRequest	Computes the cash discount for a cash discount if enabled.
CashDiscountResponse	Models the results of a cash discount calculation.
ClearTerminalRequest	The information needed to enroll a new payment method in the token vault.
CloseBatchRequest	The information needed to manually close a credit card batch.
CloseBatchResponse	The response to a close batch request.
Customer	Models a customer record.
CustomerRequest	Models a customer data request.
CustomerResponse	Models a customer data response.
CustomerSearchRequest	Models a customer data search request.
CustomerSearchResponse	Models customer search results.
CustomerToken	Models a customer token.
DeleteCustomerRequest	Deletes a customer record.
DeleteCustomerResponse	The response to a delete customer request.
DeleteQueuedTransactionRequest	Deletes one or all transactions from a terminal queue.
DeleteQueuedTransactionResponse	The response to a delete queued transaction request.
DeleteTokenRequest	Deletes a payment token.
DeleteTokenResponse	The response to a delete token request.
EnrollRequest	The information needed to enroll a new payment method in the token vault.
EnrollResponse	The response to an enroll request.
GetMerchantsRequest	Models a request for merchant information.
GetMerchantsResponse	The results for a merchant list request.
GiftActivateRequest	The information needed to activate or recharge a gift card.
GiftActivateResponse	The response to a gift activate request.
Healthcare	Fields for HSA/FSA transactions.
HealthcareGroup	A group of fields for a specific type of healthcare.
HeartbeatResponse	The response to a basic API health check.
InviteMerchantUserRequest	Models a request for adding a new user to a merchant account.
LinkTokenRequest	Links a payment token with a customer record.
ListQueuedTransactionsRequest	Returns a list of queued transactions on a terminal.
ListQueuedTransactionsResponse	A list of queued transactions on a terminal.
LocateRequest	Information needed to retrieve location information for a terminal.
LocateResponse	The response to a locate request.
MediaLibraryResponse	Models a media library response.
MediaMetadata	Models a request to retrieve survey results.
MediaRequest	Models a request to retrieve or manipulate media assets.
MerchantPlatform	Details about a merchant board platform configuration.
MerchantPlatformRequest	Models a request related to a platform configuration.
MerchantPlatformsResponse	The results for a merchant platforms inquiry.
MerchantProfile	Models a merchant profile.
MerchantProfileRequest	Models a request for information about the merchant profile.
MerchantProfileResponse	Models a response for a single merchant profile.
MerchantUser	Details about a merchant user.
MerchantUsersResponse	The results for a merchant users list.
MessageRequest	A message to be displayed on the terminal screen.
PaymentLinkRequest	Creates a payment link.
PaymentLinkResponse	Creates a payment link.
PingRequest	Information needed to test connectivity with a terminal.
PingResponse	The response to a ping request.
ReceiptSuggestions	EMV fields we recommend developers put on their receipts.
RefundRequest	A refund request.
Slide	Models a slide within a slide show.
SlideShow	Models a media library response.
SlideShowRequest	Models a request to retrieve or manipulate terminal slide shows.
SlideShowResponse	Models a slide show response.
SurveyDataPoint	Models a request to retrieve or manipulate survey questions.
SurveyQuestion	Models a survey question.
SurveyQuestionRequest	Models a request to retrieve or manipulate survey questions.
SurveyQuestionResponse	Models a survey question response.
SurveyResultsRequest	Models a request to retrieve survey results.
TerminalActivationRequest	Models a terminal activation request.
TerminalDeactivationRequest	Models a terminal deactivation request.
TerminalProfile	Details about a merchant board platform configuration.
TerminalProfileRequest	Models a terminal profile request.
TerminalProfileResponse	Models a terminal profile response.
TerminalStatusRequest	A request for the status of a terminal.
TerminalStatusResponse	The current status of a terminal.
TerminalVolume	Models transaction volume for a single terminal.
TermsAndConditionsLogEntry	Models a Terms and Conditions log entry.
TermsAndConditionsLogRequest	Models a Terms and Conditions history request.
TermsAndConditionsLogResponse	Models a Terms and Conditions history request.
TermsAndConditionsRequest	The fields needed for custom Terms and Conditions prompts.
TermsAndConditionsResponse	A signature capture response for Terms and Conditions.
TermsAndConditionsTemplate	Models a full terms and conditions template.
TermsAndConditionsTemplateRequest	Models a request to retrieve or manipulate terms and conditions data.
TermsAndConditionsTemplateResponse	Models a set of templates responsive to a request.
TextPromptRequest	A text prompt request.
TextPromptResponse	The response to a text prompt request.
TokenMetadataRequest	Retrieves token metadata.
TokenMetadataResponse	Models a payment token metadata response.
TransactionDisplayDiscount	An item level discount for transaction display.
TransactionDisplayItem	An item category in a transaction display.
TransactionDisplayRequest	Used to start or update a transaction line item display on a terminal.
TransactionDisplayTransaction	The items to display on a terminal.
TransactionHistoryRequest	Models a batch history request.
TransactionHistoryResponse	Models response to a batch history request.
TransactionStatus	Models the status of a transaction.
TransactionStatusRequest	Models the request for updated information about a transaction.
UnlinkTokenRequest	Removes a link between a payment token with a customer record, if one exists.
UpdateCustomerRequest	Models a customer data search request.
UploadMetadata	Models information needed to process a file upload.
UploadStatus	Models the current status of a file upload.
UploadStatusRequest	Used to request the status of a file upload.
VoidRequest	A void request.
VoidResponse	The response to a void request.
WhiteListedCard	Shows details about a white listed card.

Enum Summary

Enum	Description
AvsResponse
CardType
CvmType
HealthcareType
PromptType
SignatureFormat
Weekday