Package com.hybris.cis.service

Interface CisClientPaymentService

All Superinterfaces:

CisClientService

All Known Implementing Classes:

DefaultCisClientPaymentService

public interface CisClientPaymentService
extends CisClientService

CIS service which exposes the payment functionalities

Method Summary

Modifier and Type	Method	Description
com.hybris.charon.RawResponse<CisPaymentProfileResult>	addCustomerProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String documentId, CisExternalPaymentRequest cisExternalPayment)	Add a customer profile
CisPaymentTransactionResult	authorizeWithProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI profileLocation, CisPaymentAuthorization cisPaymentAuthorization)	Requests an authorization of a payment
CisPaymentTransactionResult	capture(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI authorizationLocation, java.lang.String transactionId, CisPaymentRequest paymentRequest)	Captures a payment based on the given properties
java.lang.String	deleteCustomerProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI profileLocation)	Deletes a given customer profile
CisPaymentTransactionResult	handleExternalAuthorization(java.lang.String xCisClientRef, java.lang.String tenantId, CisExternalPaymentRequest cisExternalPayment)	Requests a payment authorization
CisTokenizedPaymentTransactionResult	initPaymentSession(java.lang.String xCisClientRef, java.lang.String tenantId, CisPaymentSessionInitRequest cisPaymentSessionInitRequest)	Initialize the payment session
CisTokenizedPaymentTransactionResult	paymentOrderSetup(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI authorizationLocation, CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)	Setup order payment
com.hybris.charon.RawResponse<java.lang.String>	pspUrl(java.lang.String xCisClientRef, java.lang.String tenantId)	Retrieves the payment service url for a given client and tenant
CisPaymentTransactionResult	refund(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI captureLocation, java.lang.String transactionId, CisPaymentRequest paymentRequest)	Refunds a payment transaction
CisPaymentTransactionResult	reverse(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI authorizationLocation, java.lang.String transactionId, CisPaymentRequest paymentRequest)	Reverses a payment based on the given properties
CisTokenizedPaymentTransactionResult	tokenizedPaymentAuthorization(java.lang.String xCisClientRef, java.lang.String tenantId, CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)	Tokenized Payment Authorization
CisTokenizedPaymentTransactionResult	tokenizedPaymentCapture(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authGroupId, java.lang.String authId, CisTokenizedPaymentCapture cisTokenizedPaymentCapture)	Tokenized Payment Capture
CisTokenizedPaymentTransactionResult	tokenizedPaymentRefund(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authGroupId, java.lang.String authId, CisTokenizedPaymentRefund cisTokenizedPaymentRefund)	Tokenized Payment Refund
CisTokenizedPaymentTransactionResult	tokenizedPaymentReverse(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authGroupId, java.lang.String authId, CisTokenizedPaymentReverse cisTokenizedPaymentReverse)	Tokenized Payment Reverse
CisPaymentProfileResult	updateCustomerProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI profileLocation, CisPaymentProfileRequest cisPaymentProfileRequest)	Updates a customer profile

Methods inherited from interface com.hybris.cis.service.CisClientService

ping

Method Detail

pspUrl

com.hybris.charon.RawResponse<java.lang.String> pspUrl(java.lang.String xCisClientRef,
                                                       java.lang.String tenantId)

Retrieves the payment service url for a given client and tenant

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

Returns:

a raw response with the psp url in the location attribute of the header

handleExternalAuthorization

CisPaymentTransactionResult handleExternalAuthorization(java.lang.String xCisClientRef,
                                                        java.lang.String tenantId,
                                                        CisExternalPaymentRequest cisExternalPayment)

Requests a payment authorization

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

cisExternalPayment - the external payment request

Returns:

the result of the payment transaction

authorizeWithProfile

CisPaymentTransactionResult authorizeWithProfile(java.lang.String xCisClientRef,
                                                 java.lang.String tenantId,
                                                 java.net.URI profileLocation,
                                                 CisPaymentAuthorization cisPaymentAuthorization)

Requests an authorization of a payment

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

profileLocation - the URI of the profile to be authorized

cisPaymentAuthorization - the payment authorization to be authorized

Returns:

capture

CisPaymentTransactionResult capture(java.lang.String xCisClientRef,
                                    java.lang.String tenantId,
                                    java.net.URI authorizationLocation,
                                    java.lang.String transactionId,
                                    CisPaymentRequest paymentRequest)

Captures a payment based on the given properties

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authorizationLocation -

transactionId - the transaction identifier to be captured

paymentRequest - the corresponding payment request

Returns:

the payment transaction result

reverse

CisPaymentTransactionResult reverse(java.lang.String xCisClientRef,
                                    java.lang.String tenantId,
                                    java.net.URI authorizationLocation,
                                    java.lang.String transactionId,
                                    CisPaymentRequest paymentRequest)

Reverses a payment based on the given properties

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authorizationLocation - the location of the granted authorization

transactionId - the transaction identifier to be reversed

paymentRequest - the corresponding payment request

Returns:

the reversal payment transaction result

refund

CisPaymentTransactionResult refund(java.lang.String xCisClientRef,
                                   java.lang.String tenantId,
                                   java.net.URI captureLocation,
                                   java.lang.String transactionId,
                                   CisPaymentRequest paymentRequest)

Refunds a payment transaction

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

captureLocation - the URI of the captured location

transactionId - the transaction identifier to be reversed

paymentRequest - the corresponding payment request

Returns:

the result of the refund payment transaction

addCustomerProfile

com.hybris.charon.RawResponse<CisPaymentProfileResult> addCustomerProfile(java.lang.String xCisClientRef,
                                                                          java.lang.String tenantId,
                                                                          java.lang.String documentId,
                                                                          CisExternalPaymentRequest cisExternalPayment)

Add a customer profile

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

documentId - the document identifier

cisExternalPayment - the external payment request

Returns:

a raw response with the payment profile created

updateCustomerProfile

CisPaymentProfileResult updateCustomerProfile(java.lang.String xCisClientRef,
                                              java.lang.String tenantId,
                                              java.net.URI profileLocation,
                                              CisPaymentProfileRequest cisPaymentProfileRequest)

Updates a customer profile

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

profileLocation - the URI of the profile location

cisPaymentProfileRequest - the payment profile request

Returns:

the profile payment updated

deleteCustomerProfile

java.lang.String deleteCustomerProfile(java.lang.String xCisClientRef,
                                       java.lang.String tenantId,
                                       java.net.URI profileLocation)

Deletes a given customer profile

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

profileLocation - the URI of the profile to delete

Returns:

initPaymentSession

CisTokenizedPaymentTransactionResult initPaymentSession(java.lang.String xCisClientRef,
                                                        java.lang.String tenantId,
                                                        CisPaymentSessionInitRequest cisPaymentSessionInitRequest)

Initialize the payment session

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

cisPaymentSessionInitRequest - the payment session request

Returns:

CisTokenizedPaymentTransactionResult

paymentOrderSetup

CisTokenizedPaymentTransactionResult paymentOrderSetup(java.lang.String xCisClientRef,
                                                       java.lang.String tenantId,
                                                       java.net.URI authorizationLocation,
                                                       CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)

Setup order payment

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authorizationLocation - the URI of the authorization

cisTokenizedPaymentAuthorization -

Returns:

CisTokenizedPaymentTransactionResult

tokenizedPaymentAuthorization

CisTokenizedPaymentTransactionResult tokenizedPaymentAuthorization(java.lang.String xCisClientRef,
                                                                   java.lang.String tenantId,
                                                                   CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)

Tokenized Payment Authorization

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

cisTokenizedPaymentAuthorization -

Returns:

CisTokenizedPaymentTransactionResult

tokenizedPaymentCapture

CisTokenizedPaymentTransactionResult tokenizedPaymentCapture(java.lang.String xCisClientRef,
                                                             java.lang.String tenantId,
                                                             java.lang.String authGroupId,
                                                             java.lang.String authId,
                                                             CisTokenizedPaymentCapture cisTokenizedPaymentCapture)

Tokenized Payment Capture

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authGroupId - the authentication group identifier

authId - the authentication identifier

cisTokenizedPaymentCapture -

Returns:

CisTokenizedPaymentTransactionResult

tokenizedPaymentRefund

CisTokenizedPaymentTransactionResult tokenizedPaymentRefund(java.lang.String xCisClientRef,
                                                            java.lang.String tenantId,
                                                            java.lang.String authGroupId,
                                                            java.lang.String authId,
                                                            CisTokenizedPaymentRefund cisTokenizedPaymentRefund)

Tokenized Payment Refund

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authGroupId - the authentication group identifier

authId - the authentication identifier

cisTokenizedPaymentRefund -

Returns:

CisTokenizedPaymentTransactionResult

tokenizedPaymentReverse

CisTokenizedPaymentTransactionResult tokenizedPaymentReverse(java.lang.String xCisClientRef,
                                                             java.lang.String tenantId,
                                                             java.lang.String authGroupId,
                                                             java.lang.String authId,
                                                             CisTokenizedPaymentReverse cisTokenizedPaymentReverse)

Tokenized Payment Reverse

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authGroupId - the authentication group identifier

authId - the authentication identifier

cisTokenizedPaymentReverse -

Returns:

CisTokenizedPaymentTransactionResult