Package com.broadleafcommerce.payment.service.gateway.privider

Interface VerifoneProvider

All Known Implementing Classes:

ExternalVerifoneProvider

public interface VerifoneProvider

The Verifone provider that is used to execute the requests to the Verifone API.

Author:

Dima Myroniuk (dmyroniuk)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	authorizeAndCaptureTransaction(Map<String,Object> bodyParams, String applicationId, String tenantId)	Executes the DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE transactions.
Map<String,Object>	authorizeTransaction(Map<String,Object> bodyParams, String applicationId, String tenantId)	Executes the DefaultTransactionTypes.AUTHORIZE transactions.
Map<String,Object>	captureTransaction(String transactionId, Map<String,Object> bodyParams, String applicationId, String tenantId)	Executes the DefaultTransactionTypes.CAPTURE transactions.
Map<String,Object>	createUpdateToken(@NonNull Map<String,Object> bodyParams, String applicationId, String tenantId)	Create/Update a token using the Verifone Tokenisation Service.
void	deleteToken(String id, String applicationId, String tenantId)	Deletes a token using the Verifone Tokenisation Service.
Map<String,Object>	initiateWalletPayment(@NonNull Map<String,Object> bodyParams, String applicationId, String tenantId)	Initiate a wallet payment using Google Pay or Apple Pay.
Map<String,Object>	refundTransaction(String transactionId, Map<String,Object> bodyParams, String applicationId, String tenantId)	Executes the DefaultTransactionTypes.REFUND transactions.
Map<String,Object>	reverseAuthorizeTransaction(String transactionId, String applicationId, String tenantId)	Executes the DefaultTransactionTypes.REVERSE_AUTH transactions.
Map<String,Object>	updateToken(String id, @NonNull Map<String,Object> bodyParams, String applicationId, String tenantId)	Updates a token using the Verifone Tokenisation Service.
Map<String,Object>	voidTransaction(String transactionId, String applicationId, String tenantId)	Executes the DefaultTransactionTypes.REFUND transactions.

Method Detail

authorizeTransaction

Map<String,Object> authorizeTransaction(Map<String,Object> bodyParams,
                                              @Nullable
                                              String applicationId,
                                              @Nullable
                                              String tenantId)

Executes the DefaultTransactionTypes.AUTHORIZE transactions.

Parameters:

bodyParams - the request body

applicationId - the application id

tenantId - the tenant id

Returns:

the response from Verifone API

Throws:

ProviderApiException - if the request failed

authorizeAndCaptureTransaction

Map<String,Object> authorizeAndCaptureTransaction(Map<String,Object> bodyParams,
                                                        @Nullable
                                                        String applicationId,
                                                        @Nullable
                                                        String tenantId)

Executes the DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE transactions.

Parameters:

bodyParams - the request body

applicationId - the application id

tenantId - the tenant id

Returns:

the response from Verifone API

Throws:

ProviderApiException - if the request failed

reverseAuthorizeTransaction

Map<String,Object> reverseAuthorizeTransaction(String transactionId,
                                                     @Nullable
                                                     String applicationId,
                                                     @Nullable
                                                     String tenantId)

Executes the DefaultTransactionTypes.REVERSE_AUTH transactions.

Parameters:

transactionId - the transaction id to reverse

applicationId - the application id

tenantId - the tenant id

Returns:

the response from Verifone API

Throws:

ProviderApiException - if the request failed

captureTransaction

Map<String,Object> captureTransaction(String transactionId,
                                            Map<String,Object> bodyParams,
                                            @Nullable
                                            String applicationId,
                                            @Nullable
                                            String tenantId)

Executes the DefaultTransactionTypes.CAPTURE transactions.

Parameters:

transactionId - the transaction id to capture

bodyParams - the request body

applicationId - the application id

tenantId - the tenant id

Returns:

the response from Verifone API

Throws:

ProviderApiException - if the request failed

refundTransaction

Map<String,Object> refundTransaction(String transactionId,
                                           Map<String,Object> bodyParams,
                                           @Nullable
                                           String applicationId,
                                           @Nullable
                                           String tenantId)

Executes the DefaultTransactionTypes.REFUND transactions. The transaction status should be SETTLEMENT_COMPLETED.

Parameters:

transactionId - the transaction id to reverse

bodyParams - the request body

applicationId - the application id

tenantId - the tenant id

Returns:

the response from Verifone API

Throws:

ProviderApiException - if the request failed

voidTransaction

Map<String,Object> voidTransaction(String transactionId,
                                         @Nullable
                                         String applicationId,
                                         @Nullable
                                         String tenantId)

Executes the DefaultTransactionTypes.REFUND transactions. The transaction status should be SETTLEMENT_REQUESTED.

Parameters:

transactionId - the transaction id to reverse

applicationId - the application id

tenantId - the tenant id

Returns:

the response from Verifone API

Throws:

ProviderApiException - if the request failed

createUpdateToken

Map<String,Object> createUpdateToken(@NonNull
                                           @NonNull Map<String,Object> bodyParams,
                                           @Nullable
                                           String applicationId,
                                           @Nullable
                                           String tenantId)

Create/Update a token using the Verifone Tokenisation Service.

Parameters:

bodyParams - the request body

applicationId - the application id

tenantId - the tenant id

Returns:

the response from Verifone API

Throws:

ProviderApiException - if the request failed

updateToken

Map<String,Object> updateToken(String id,
                                     @NonNull
                                     @NonNull Map<String,Object> bodyParams,
                                     @Nullable
                                     String applicationId,
                                     @Nullable
                                     String tenantId)

Updates a token using the Verifone Tokenisation Service.

Parameters:

id - the reuse token to update

bodyParams - the request body

applicationId - the application id

tenantId - the tenant id

Returns:

the response from Verifone API

Throws:

ProviderApiException - if the request failed

deleteToken

void deleteToken(String id,
                 @Nullable
                 String applicationId,
                 @Nullable
                 String tenantId)

Deletes a token using the Verifone Tokenisation Service.

Parameters:

id - the reuse token to delete

applicationId - the application id

tenantId - the tenant id

Throws:

ProviderApiException - if the request failed

initiateWalletPayment

Map<String,Object> initiateWalletPayment(@NonNull
                                               @NonNull Map<String,Object> bodyParams,
                                               @Nullable
                                               String applicationId,
                                               @Nullable
                                               String tenantId)

Initiate a wallet payment using Google Pay or Apple Pay.

Parameters:

bodyParams - the request body

applicationId - the application id

tenantId - the tenant id

Returns:

the response from Verifone API

Throws:

ProviderApiException - if the request failed