com.shift4

Class Shift4Gateway

java.lang.Object

com.shift4.Shift4Gateway

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class Shift4Gateway
extends java.lang.Object
implements java.io.Closeable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ENDPOINT
static java.lang.String	UPLOADS_ENDPOINT

Constructor Summary

Constructors

Constructor and Description
Shift4Gateway()
Shift4Gateway(java.lang.String secretKey)
Shift4Gateway(java.lang.String secretKey, Connection connection)
Shift4Gateway(java.lang.String secretKey, java.lang.String merchantId)
Shift4Gateway(java.lang.String secretKey, java.lang.String merchantId, Connection connection)

Method Summary

Modifier and Type	Method and Description
Subscription	cancelSubscription(SubscriptionCancelRequest request)
Charge	captureCharge(CaptureRequest request)
Charge	captureCharge(CaptureRequest request, RequestOptions requestOptions)
void	close()
Dispute	closeDispute(java.lang.String id)
BlacklistRule	createBlacklistRule(BlacklistRuleRequest request)
BlacklistRule	createBlacklistRule(BlacklistRuleRequest request, RequestOptions requestOptions)
Card	createCard(CardRequest request)
Card	createCard(CardRequest request, RequestOptions requestOptions)
Charge	createCharge(ChargeRequest request)
Charge	createCharge(ChargeRequest request, RequestOptions requestOptions)
Credit	createCredit(CreditRequest request)
Credit	createCredit(CreditRequest request, RequestOptions requestOptions)
Customer	createCustomer(CustomerRequest request)
Customer	createCustomer(CustomerRequest request, RequestOptions requestOptions)
FileUpload	createFileUpload(java.io.File file, FileUploadPurpose purpose)
PaymentMethod	createPaymentMethod(PaymentMethodRequest request)
PaymentMethod	createPaymentMethod(PaymentMethodRequest request, RequestOptions requestOptions)
Payout	createPayout()
Plan	createPlan(PlanRequest request)
Plan	createPlan(PlanRequest request, RequestOptions requestOptions)
Refund	createRefund(RefundRequest request)
Refund	createRefund(RefundRequest request, RequestOptions requestOptions)
Subscription	createSubscription(SubscriptionRequest request)
Subscription	createSubscription(SubscriptionRequest request, RequestOptions requestOptions)
Token	createToken(TokenRequest request)
Token	createToken(TokenRequest request, RequestOptions requestOptions)
protected <T> T	delete(java.lang.String path, java.lang.Class<T> responseClass)
protected <T> T	delete(java.lang.String path, java.lang.Object request, java.lang.Class<T> responseClass)
DeleteResponse	deleteBlacklistRule(java.lang.String blacklistRuleId)
DeleteResponse	deleteCard(java.lang.String customerId, java.lang.String cardId)
DeleteResponse	deleteCustomer(java.lang.String customerId)
DeleteResponse	deletePaymentMethod(java.lang.String paymentMethodId)
DeleteResponse	deletePlan(java.lang.String planId)
protected <T> T	get(java.lang.String path, java.lang.Class<T> responseClass)
protected <T> T	get(java.lang.String path, java.lang.Class<T> responseClass, Expand expand)
protected <T> T	get(java.lang.String path, java.lang.Class<T> responseClass, RequestOptions options, Expand expand)
protected <T> ListResponse<T>	list(java.lang.String path, java.lang.Class<T> elementClass)
protected <T> ListResponse<T>	list(java.lang.String path, java.lang.Object request, java.lang.Class<T> elementClass)
protected <T> ListResponse<T>	list(java.lang.String path, java.lang.Object request, RequestOptions options, java.lang.Class<T> elementClass)
ListResponse<BlacklistRule>	listBlacklistRules()
ListResponse<BlacklistRule>	listBlacklistRules(BlacklistRuleListRequest request)
ListResponse<Card>	listCards(CardListRequest listCards)
ListResponse<Card>	listCards(java.lang.String customerId)
ListResponse<Charge>	listCharges()
ListResponse<Charge>	listCharges(ChargeListRequest request)
ListResponse<Credit>	listCredits()
ListResponse<Credit>	listCredits(CreditListRequest request)
ListResponse<Customer>	listCustomers()
ListResponse<Customer>	listCustomers(CustomerListRequest request)
ListResponse<Dispute>	listDisputes()
ListResponse<Dispute>	listDisputes(DisputeListRequest request)
ListResponse<Event>	listEvents()
ListResponse<Event>	listEvents(EventListRequest listEvents)
ListResponse<FileUpload>	listFileUploads()
ListResponse<FileUpload>	listFileUploads(FileUploadListRequest request)
ListResponse<FraudWarning>	listFraudWarnings()
ListResponse<FraudWarning>	listFraudWarnings(FraudWarningListRequest request)
ListResponse<PaymentMethod>	listPaymentMethods(PaymentMethodListRequest listRequest)
ListResponse<Payout>	listPayouts()
ListResponse<Payout>	listPayouts(PayoutListRequest request)
ListResponse<PayoutTransaction>	listPayoutTransactions(PayoutTransactionListRequest request)
ListResponse<PayoutTransaction>	listPayoutTransactions(java.lang.String payoutId)
ListResponse<Plan>	listPlans()
ListResponse<Plan>	listPlans(PlanListRequest request)
ListResponse<Refund>	listRefunds(RefundListRequest request)
ListResponse<Refund>	listRefunds(java.lang.String chargeId)
ListResponse<Subscription>	listSubscriptions(java.lang.String customerId)
ListResponse<Subscription>	listSubscriptions(SubscriptionListRequest request)
protected <T> T	post(java.lang.String path, java.lang.Object request, java.lang.Class<T> responseClass)
protected <T> T	post(java.lang.String path, java.lang.Object request, RequestOptions options, java.lang.Class<T> responseClass)
BlacklistRule	retrieveBlacklistRule(java.lang.String blacklistRuleId)
Card	retrieveCard(java.lang.String customerId, java.lang.String cardId)
Charge	retrieveCharge(java.lang.String chargeId)
Credit	retrieveCredit(java.lang.String creditId)
Customer	retrieveCustomer(java.lang.String customerId)
Dispute	retrieveDispute(java.lang.String id)
Event	retrieveEvent(java.lang.String eventId)
FileUpload	retrieveFileUpload(java.lang.String id)
FraudWarning	retrieveFraudWarning(java.lang.String id)
PaymentMethod	retrievePaymentMethod(java.lang.String paymentMethodId)
Payout	retrievePayout(java.lang.String id)
Plan	retrievePlan(java.lang.String planId)
Refund	retrieveRefund(java.lang.String refundId)
Subscription	retrieveSubscription(java.lang.String subscriptionId)
Token	retrieveToken(java.lang.String tokenId)
void	setConnection(Connection connection)
void	setEndpoint(java.lang.String endpoint)
void	setHeadersFactory(com.shift4.Shift4GatewayHeadersFactory headersFactory)
void	setMerchantId(java.lang.String merchantId)
void	setSecretKey(java.lang.String secretKey)
void	setUploadsEndpoint(java.lang.String uploadsEndpoint)
java.lang.String	signCheckoutRequest(CheckoutRequest checkoutRequest)
Card	updateCard(CardUpdateRequest card)
Card	updateCard(CardUpdateRequest card, RequestOptions requestOptions)
Charge	updateCharge(ChargeUpdateRequest request)
Charge	updateCharge(ChargeUpdateRequest request, RequestOptions requestOptions)
Credit	updateCredit(CreditUpdateRequest credit)
Credit	updateCredit(CreditUpdateRequest credit, RequestOptions requestOptions)
Customer	updateCustomer(CustomerUpdateRequest request)
Customer	updateCustomer(CustomerUpdateRequest request, RequestOptions requestOptions)
Dispute	updateDispute(DisputeUpdateRequest request)
Dispute	updateDispute(DisputeUpdateRequest request, RequestOptions requestOptions)
Plan	updatePlan(PlanUpdateRequest request)
Plan	updatePlan(PlanUpdateRequest request, RequestOptions requestOptions)
Refund	updateRefund(RefundUpdateRequest request)
Refund	updateRefund(RefundUpdateRequest request, RequestOptions requestOptions)
Subscription	updateSubscription(SubscriptionUpdateRequest request)
Subscription	updateSubscription(SubscriptionUpdateRequest request, RequestOptions requestOptions)
protected <T> T	uploadsGet(java.lang.String path, java.lang.Class<T> responseClass)
protected <T> ListResponse<T>	uploadslist(java.lang.String path, java.lang.Object request, java.lang.Class<T> elementClass)
protected <T> T	uploadsMultipart(java.lang.String path, java.util.Map<java.lang.String,java.io.File> files, java.util.Map<java.lang.String,java.lang.String> form, java.lang.Class<T> responseClass)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ENDPOINT

public static final java.lang.String DEFAULT_ENDPOINT

See Also:

Constant Field Values

UPLOADS_ENDPOINT

public static final java.lang.String UPLOADS_ENDPOINT

See Also:

Constant Field Values

Constructor Detail

Shift4Gateway

public Shift4Gateway()

Shift4Gateway

public Shift4Gateway(java.lang.String secretKey)

Shift4Gateway

public Shift4Gateway(java.lang.String secretKey,
                     java.lang.String merchantId)

Shift4Gateway

public Shift4Gateway(java.lang.String secretKey,
                     Connection connection)

Shift4Gateway

public Shift4Gateway(java.lang.String secretKey,
                     java.lang.String merchantId,
                     Connection connection)

Method Detail

createCharge

public Charge createCharge(ChargeRequest request)

createCharge

public Charge createCharge(ChargeRequest request,
                           RequestOptions requestOptions)

captureCharge

public Charge captureCharge(CaptureRequest request)

captureCharge

public Charge captureCharge(CaptureRequest request,
                            RequestOptions requestOptions)

retrieveCharge

public Charge retrieveCharge(java.lang.String chargeId)

updateCharge

public Charge updateCharge(ChargeUpdateRequest request)

updateCharge

public Charge updateCharge(ChargeUpdateRequest request,
                           RequestOptions requestOptions)

listCharges

public ListResponse<Charge> listCharges()

listCharges

public ListResponse<Charge> listCharges(ChargeListRequest request)

createCustomer

public Customer createCustomer(CustomerRequest request)

createCustomer

public Customer createCustomer(CustomerRequest request,
                               RequestOptions requestOptions)

retrieveCustomer

public Customer retrieveCustomer(java.lang.String customerId)

updateCustomer

public Customer updateCustomer(CustomerUpdateRequest request)

updateCustomer

public Customer updateCustomer(CustomerUpdateRequest request,
                               RequestOptions requestOptions)

deleteCustomer

public DeleteResponse deleteCustomer(java.lang.String customerId)

listCustomers

public ListResponse<Customer> listCustomers()

listCustomers

public ListResponse<Customer> listCustomers(CustomerListRequest request)

createCard

public Card createCard(CardRequest request)

createCard

public Card createCard(CardRequest request,
                       RequestOptions requestOptions)

retrieveCard

public Card retrieveCard(java.lang.String customerId,
                         java.lang.String cardId)

updateCard

public Card updateCard(CardUpdateRequest card)

updateCard

public Card updateCard(CardUpdateRequest card,
                       RequestOptions requestOptions)

deleteCard

public DeleteResponse deleteCard(java.lang.String customerId,
                                 java.lang.String cardId)

listCards

public ListResponse<Card> listCards(java.lang.String customerId)

listCards

public ListResponse<Card> listCards(CardListRequest listCards)

createPaymentMethod

public PaymentMethod createPaymentMethod(PaymentMethodRequest request)

createPaymentMethod

public PaymentMethod createPaymentMethod(PaymentMethodRequest request,
                                         RequestOptions requestOptions)

retrievePaymentMethod

public PaymentMethod retrievePaymentMethod(java.lang.String paymentMethodId)

listPaymentMethods

public ListResponse<PaymentMethod> listPaymentMethods(PaymentMethodListRequest listRequest)

deletePaymentMethod

public DeleteResponse deletePaymentMethod(java.lang.String paymentMethodId)

createSubscription

public Subscription createSubscription(SubscriptionRequest request)

createSubscription

public Subscription createSubscription(SubscriptionRequest request,
                                       RequestOptions requestOptions)

retrieveSubscription

public Subscription retrieveSubscription(java.lang.String subscriptionId)

updateSubscription

public Subscription updateSubscription(SubscriptionUpdateRequest request)

updateSubscription

public Subscription updateSubscription(SubscriptionUpdateRequest request,
                                       RequestOptions requestOptions)

cancelSubscription

public Subscription cancelSubscription(SubscriptionCancelRequest request)

listSubscriptions

public ListResponse<Subscription> listSubscriptions(java.lang.String customerId)

listSubscriptions

public ListResponse<Subscription> listSubscriptions(SubscriptionListRequest request)

createPlan

public Plan createPlan(PlanRequest request)

createPlan

public Plan createPlan(PlanRequest request,
                       RequestOptions requestOptions)

retrievePlan

public Plan retrievePlan(java.lang.String planId)

updatePlan

public Plan updatePlan(PlanUpdateRequest request)

updatePlan

public Plan updatePlan(PlanUpdateRequest request,
                       RequestOptions requestOptions)

deletePlan

public DeleteResponse deletePlan(java.lang.String planId)

listPlans

public ListResponse<Plan> listPlans()

listPlans

public ListResponse<Plan> listPlans(PlanListRequest request)

retrieveEvent

public Event retrieveEvent(java.lang.String eventId)

listEvents

public ListResponse<Event> listEvents()

listEvents

public ListResponse<Event> listEvents(EventListRequest listEvents)

createToken

public Token createToken(TokenRequest request)

createToken

public Token createToken(TokenRequest request,
                         RequestOptions requestOptions)

retrieveToken

public Token retrieveToken(java.lang.String tokenId)

createBlacklistRule

public BlacklistRule createBlacklistRule(BlacklistRuleRequest request)

createBlacklistRule

public BlacklistRule createBlacklistRule(BlacklistRuleRequest request,
                                         RequestOptions requestOptions)

retrieveBlacklistRule

public BlacklistRule retrieveBlacklistRule(java.lang.String blacklistRuleId)

deleteBlacklistRule

public DeleteResponse deleteBlacklistRule(java.lang.String blacklistRuleId)

listBlacklistRules

public ListResponse<BlacklistRule> listBlacklistRules()

listBlacklistRules

public ListResponse<BlacklistRule> listBlacklistRules(BlacklistRuleListRequest request)

createCredit

public Credit createCredit(CreditRequest request)

createCredit

public Credit createCredit(CreditRequest request,
                           RequestOptions requestOptions)

retrieveCredit

public Credit retrieveCredit(java.lang.String creditId)

updateCredit

public Credit updateCredit(CreditUpdateRequest credit)

updateCredit

public Credit updateCredit(CreditUpdateRequest credit,
                           RequestOptions requestOptions)

listCredits

public ListResponse<Credit> listCredits()

listCredits

public ListResponse<Credit> listCredits(CreditListRequest request)

signCheckoutRequest

public java.lang.String signCheckoutRequest(CheckoutRequest checkoutRequest)

createFileUpload

public FileUpload createFileUpload(java.io.File file,
                                   FileUploadPurpose purpose)

retrieveFileUpload

public FileUpload retrieveFileUpload(java.lang.String id)

listFileUploads

public ListResponse<FileUpload> listFileUploads()

listFileUploads

public ListResponse<FileUpload> listFileUploads(FileUploadListRequest request)

retrieveDispute

public Dispute retrieveDispute(java.lang.String id)

updateDispute

public Dispute updateDispute(DisputeUpdateRequest request)

updateDispute

public Dispute updateDispute(DisputeUpdateRequest request,
                             RequestOptions requestOptions)

closeDispute

public Dispute closeDispute(java.lang.String id)

listDisputes

public ListResponse<Dispute> listDisputes()

listDisputes

public ListResponse<Dispute> listDisputes(DisputeListRequest request)

listFraudWarnings

public ListResponse<FraudWarning> listFraudWarnings()

listFraudWarnings

public ListResponse<FraudWarning> listFraudWarnings(FraudWarningListRequest request)

retrieveFraudWarning

public FraudWarning retrieveFraudWarning(java.lang.String id)

retrieveRefund

public Refund retrieveRefund(java.lang.String refundId)

createRefund

public Refund createRefund(RefundRequest request)

createRefund

public Refund createRefund(RefundRequest request,
                           RequestOptions requestOptions)

updateRefund

public Refund updateRefund(RefundUpdateRequest request)

updateRefund

public Refund updateRefund(RefundUpdateRequest request,
                           RequestOptions requestOptions)

listRefunds

public ListResponse<Refund> listRefunds(java.lang.String chargeId)

listRefunds

public ListResponse<Refund> listRefunds(RefundListRequest request)

retrievePayout

public Payout retrievePayout(java.lang.String id)

createPayout

public Payout createPayout()

listPayouts

public ListResponse<Payout> listPayouts()

listPayouts

public ListResponse<Payout> listPayouts(PayoutListRequest request)

listPayoutTransactions

public ListResponse<PayoutTransaction> listPayoutTransactions(java.lang.String payoutId)

listPayoutTransactions

public ListResponse<PayoutTransaction> listPayoutTransactions(PayoutTransactionListRequest request)

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

get

protected <T> T get(java.lang.String path,
                    java.lang.Class<T> responseClass)

get

protected <T> T get(java.lang.String path,
                    java.lang.Class<T> responseClass,
                    Expand expand)

get

protected <T> T get(java.lang.String path,
                    java.lang.Class<T> responseClass,
                    RequestOptions options,
                    Expand expand)

uploadsGet

protected <T> T uploadsGet(java.lang.String path,
                           java.lang.Class<T> responseClass)

post

protected <T> T post(java.lang.String path,
                     java.lang.Object request,
                     java.lang.Class<T> responseClass)

post

protected <T> T post(java.lang.String path,
                     java.lang.Object request,
                     RequestOptions options,
                     java.lang.Class<T> responseClass)

uploadsMultipart

protected <T> T uploadsMultipart(java.lang.String path,
                                 java.util.Map<java.lang.String,java.io.File> files,
                                 java.util.Map<java.lang.String,java.lang.String> form,
                                 java.lang.Class<T> responseClass)

list

protected <T> ListResponse<T> list(java.lang.String path,
                                   java.lang.Class<T> elementClass)

list

protected <T> ListResponse<T> list(java.lang.String path,
                                   java.lang.Object request,
                                   java.lang.Class<T> elementClass)

list

protected <T> ListResponse<T> list(java.lang.String path,
                                   java.lang.Object request,
                                   RequestOptions options,
                                   java.lang.Class<T> elementClass)

uploadslist

protected <T> ListResponse<T> uploadslist(java.lang.String path,
                                          java.lang.Object request,
                                          java.lang.Class<T> elementClass)

delete

protected <T> T delete(java.lang.String path,
                       java.lang.Class<T> responseClass)

delete

protected <T> T delete(java.lang.String path,
                       java.lang.Object request,
                       java.lang.Class<T> responseClass)

setSecretKey

public void setSecretKey(java.lang.String secretKey)

setConnection

public void setConnection(Connection connection)

setEndpoint

public void setEndpoint(java.lang.String endpoint)

setUploadsEndpoint

public void setUploadsEndpoint(java.lang.String uploadsEndpoint)

setMerchantId

public void setMerchantId(java.lang.String merchantId)

setHeadersFactory

public void setHeadersFactory(com.shift4.Shift4GatewayHeadersFactory headersFactory)