Package de.hybris.platform.cissapdigitalpayment.client

Interface SapDigitalPaymentClient

public interface SapDigitalPaymentClient

Client to connect to SAP Digital payment using Charon API.

Method Summary

Modifier and Type	Method	Description
rx.Observable<CisSapDigitalPaymentAuthorizationResultList>	authorizatePayment(CisSapDigitalPaymentAuthorizationRequestList authorizationRequests)	Authorize the payment
rx.Observable<CisSapDigitalPaymentChargeResultList>	chargePayment(CisSapDigitalPaymentChargeRequestList chargeRequests)	Charge the payment
rx.Observable<CisSapDigitalPaymentCardDeletionResultList>	deleteCard(CisSapDigitalPaymentCardDeletionRequestList deletCardRequests)	Delete the card
DigitalPaymentsRegistrationModel	fetchRegistrationUrl()	Fetches the new card registration details for payment card
DigitalPaymentsRegistrationModel	fetchRegistrationUrl(DigitalPaymentsRegistrationRequest registrationRequestModel)	Fetch the Registration URL and the session ID from SAP Digital payment
rx.Observable<CisSapDigitalPaymentRegistrationUrlResult>	getRegistrationUrl()	Deprecated. instead use getRegistrationUrl(DigitalPaymentsRegistrationRequest)
CisSapDigitalPaymentRegistrationUrlResult	getRegistrationUrl(DigitalPaymentsRegistrationRequest registrationRequestModel)	Fetch the Registration URL and the session ID from SAP Digital payment
DigitalPaymentsPollModel	poll(String sessionId)	Poll the registered Card
rx.Observable<CisSapDigitalPaymentPollRegisteredCardResult>	pollRegisteredCard(String sessionId)	Poll the registered card using the session ID
rx.Observable<CisSapDigitalPaymentRefundResultList>	refundPayment(CisSapDigitalPaymentRefundRequestList refundRequests)	Refund the payment

Method Details

getRegistrationUrl

@Deprecated(since="1905.2004")
@GET
@Produces("application/json")
@Path("/cards/getregistrationurl?CompanyCode=${CompanyCode}&CustomerCountry=${CustomerCountry}&PaymentMethod=${PaymentMethod}&RoutingCustomParameterValue=${RoutingCustomParameterValue}")
rx.Observable<CisSapDigitalPaymentRegistrationUrlResult> getRegistrationUrl()
                                                                     throws TimeoutException

Deprecated.

instead use getRegistrationUrl(DigitalPaymentsRegistrationRequest)

Fetch the Registration URL and the session ID from SAP Digital payment

Returns:

CisSapDigitalPaymentRegistrationUrlResult

Throws:

TimeoutException

getRegistrationUrl

@POST
@Produces("application/json")
@Path("/cards/getregistrationurl")
CisSapDigitalPaymentRegistrationUrlResult getRegistrationUrl(DigitalPaymentsRegistrationRequest registrationRequestModel)
                                                      throws TimeoutException

Fetch the Registration URL and the session ID from SAP Digital payment

Throws:

TimeoutException

pollRegisteredCard

@GET
@Produces("application/json")
@Path("/cards/poll/{sessionId}")
rx.Observable<CisSapDigitalPaymentPollRegisteredCardResult> pollRegisteredCard(@PathParam("sessionId")
 String sessionId)

Poll the registered card using the session ID

Parameters:

sessionId - session id

Returns:

CisSapDigitalPaymentPollRegisteredCardResult

authorizatePayment

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/authorizations")
rx.Observable<CisSapDigitalPaymentAuthorizationResultList> authorizatePayment(CisSapDigitalPaymentAuthorizationRequestList authorizationRequests)

Authorize the payment

Parameters:

authorizationRequests - authorization request

Returns:

CisSapDigitalPaymentAuthorizationResultList

deleteCard

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/cards/delete")
rx.Observable<CisSapDigitalPaymentCardDeletionResultList> deleteCard(CisSapDigitalPaymentCardDeletionRequestList deletCardRequests)

Delete the card

Parameters:

deletCardRequests - delete card Request

Returns:

CisSapDigitalPaymentCardDeletionResultList

chargePayment

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/charges")
rx.Observable<CisSapDigitalPaymentChargeResultList> chargePayment(CisSapDigitalPaymentChargeRequestList chargeRequests)

Charge the payment

Parameters:

chargeRequests - charge requests

Returns:

CisSapDigitalPaymentChargeResultList

refundPayment

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/refunds")
rx.Observable<CisSapDigitalPaymentRefundResultList> refundPayment(CisSapDigitalPaymentRefundRequestList refundRequests)

Refund the payment

Parameters:

refundRequests - refund requests

Returns:

CisSapDigitalPaymentRefundResultList

poll

@GET
@Produces("application/json")
@Path("/cards/poll/{sessionId}")
DigitalPaymentsPollModel poll(@PathParam("sessionId")
 String sessionId)

Poll the registered Card

Parameters:

sessionId - sessionId of digital payment

Returns:

poll model

fetchRegistrationUrl

@GET
@Produces("application/json")
@Path("/cards/getregistrationurl?CompanyCode=${CompanyCode}&CustomerCountry=${CustomerCountry}&PaymentMethod=${PaymentMethod}&RoutingCustomParameterValue=${RoutingCustomParameterValue}")
DigitalPaymentsRegistrationModel fetchRegistrationUrl()

Fetches the new card registration details for payment card

Returns:

model for registration url

fetchRegistrationUrl

@POST
@Produces("application/json")
@Path("/cards/getregistrationurl")
DigitalPaymentsRegistrationModel fetchRegistrationUrl(DigitalPaymentsRegistrationRequest registrationRequestModel)
                                               throws TimeoutException

Fetch the Registration URL and the session ID from SAP Digital payment

Throws:

TimeoutException