Package com.hybris.cis.client.payment

Interface PaymentClient

All Superinterfaces:

CisClient

All Known Implementing Classes:

PaymentClientMock

public interface PaymentClient
extends CisClient

Charon Client to CIS Payment API

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)
CisPaymentTransactionResult	authorizeWithProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String profileId, CisPaymentAuthorization cisPaymentAuthorization)
CisPaymentTransactionResult	capture(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authId, java.lang.String transactionId, CisPaymentRequest paymentRequest)
java.lang.String	deleteCustomerProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String profileId)
CisPaymentTransactionResult	handleExternalAuthorization(java.lang.String xCisClientRef, java.lang.String tenantId, CisExternalPaymentRequest cisExternalPayment)
CisTokenizedPaymentTransactionResult	initPaymentSession(java.lang.String xCisClientRef, java.lang.String tenantId, CisPaymentSessionInitRequest cisPaymentSessionInitRequest)
CisTokenizedPaymentTransactionResult	paymentOrderSetup(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authGroupId, CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)
com.hybris.charon.RawResponse<java.lang.String>	pspUrl(java.lang.String xCisClientRef, java.lang.String tenantId)
CisPaymentTransactionResult	refund(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authId, java.lang.String transactionId, CisPaymentRequest paymentRequest)
CisPaymentTransactionResult	reverse(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authId, java.lang.String transactionId, CisPaymentRequest paymentRequest)
CisTokenizedPaymentTransactionResult	tokenizedPaymentAuthorization(java.lang.String xCisClientRef, java.lang.String tenantId, CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)
CisTokenizedPaymentTransactionResult	tokenizedPaymentCapture(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authGroupId, java.lang.String authId, CisTokenizedPaymentCapture cisTokenizedPaymentCapture)
CisTokenizedPaymentTransactionResult	tokenizedPaymentRefund(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authGroupId, java.lang.String authId, java.lang.String transactionId, CisTokenizedPaymentRefund cisTokenizedPaymentRefund)
CisTokenizedPaymentTransactionResult	tokenizedPaymentReverse(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authGroupId, java.lang.String authId, CisTokenizedPaymentReverse cisTokenizedPaymentReverse)
CisPaymentProfileResult	updateCustomerProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String profileId, CisPaymentProfileRequest cisPaymentProfileRequest)

Methods inherited from interface com.hybris.cis.client.CisClient

doPing

Method Detail

pspUrl

@HEAD
@Produces("application/json")
@Consumes("application/json")
@Path("/hpfurl")
com.hybris.charon.RawResponse<java.lang.String> pspUrl(@HeaderParam("X-CIS-Client-Ref")
                                                       java.lang.String xCisClientRef,
                                                       @HeaderParam("X-tenantId")
                                                       java.lang.String tenantId)

handleExternalAuthorization

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/authorizations")
CisPaymentTransactionResult handleExternalAuthorization(@HeaderParam("X-CIS-Client-Ref")
                                                        java.lang.String xCisClientRef,
                                                        @HeaderParam("X-tenantId")
                                                        java.lang.String tenantId,
                                                        CisExternalPaymentRequest cisExternalPayment)

authorizeWithProfile

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/profiles/{profileId}/authorizations")
CisPaymentTransactionResult authorizeWithProfile(@HeaderParam("X-CIS-Client-Ref")
                                                 java.lang.String xCisClientRef,
                                                 @HeaderParam("X-tenantId")
                                                 java.lang.String tenantId,
                                                 @PathParam("profileId")
                                                 java.lang.String profileId,
                                                 CisPaymentAuthorization cisPaymentAuthorization)

capture

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/authorizations/{authId}/{transactionId}/captures")
CisPaymentTransactionResult capture(@HeaderParam("X-CIS-Client-Ref")
                                    java.lang.String xCisClientRef,
                                    @HeaderParam("X-tenantId")
                                    java.lang.String tenantId,
                                    @PathParam("authId")
                                    java.lang.String authId,
                                    @PathParam("transactionId")
                                    java.lang.String transactionId,
                                    CisPaymentRequest paymentRequest)

reverse

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/authorizations/{authId}/{transactionId}/reverses")
CisPaymentTransactionResult reverse(@HeaderParam("X-CIS-Client-Ref")
                                    java.lang.String xCisClientRef,
                                    @HeaderParam("X-tenantId")
                                    java.lang.String tenantId,
                                    @PathParam("authId")
                                    java.lang.String authId,
                                    @PathParam("transactionId")
                                    java.lang.String transactionId,
                                    CisPaymentRequest paymentRequest)

refund

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/authorizations/{authId}/{transactionId}/refunds")
CisPaymentTransactionResult refund(@HeaderParam("X-CIS-Client-Ref")
                                   java.lang.String xCisClientRef,
                                   @HeaderParam("X-tenantId")
                                   java.lang.String tenantId,
                                   @PathParam("authId")
                                   java.lang.String authId,
                                   @PathParam("transactionId")
                                   java.lang.String transactionId,
                                   CisPaymentRequest paymentRequest)

addCustomerProfile

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/profiles/{documentId}")
com.hybris.charon.RawResponse<CisPaymentProfileResult> addCustomerProfile(@HeaderParam("X-CIS-Client-Ref")
                                                                          java.lang.String xCisClientRef,
                                                                          @HeaderParam("X-tenantId")
                                                                          java.lang.String tenantId,
                                                                          @PathParam("documentId")
                                                                          java.lang.String documentId,
                                                                          CisExternalPaymentRequest cisExternalPayment)

updateCustomerProfile

@PUT
@Produces("application/json")
@Consumes("application/json")
@Path("/profiles/{profileId}")
CisPaymentProfileResult updateCustomerProfile(@HeaderParam("X-CIS-Client-Ref")
                                              java.lang.String xCisClientRef,
                                              @HeaderParam("X-tenantId")
                                              java.lang.String tenantId,
                                              @PathParam("profileId")
                                              java.lang.String profileId,
                                              CisPaymentProfileRequest cisPaymentProfileRequest)

deleteCustomerProfile

@DELETE
@Produces("application/json")
@Consumes("application/json")
@Path("/profiles/{profileId}")
java.lang.String deleteCustomerProfile(@HeaderParam("X-CIS-Client-Ref")
                                       java.lang.String xCisClientRef,
                                       @HeaderParam("X-tenantId")
                                       java.lang.String tenantId,
                                       @PathParam("profileId")
                                       java.lang.String profileId)

initPaymentSession

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/paymentsessions")
CisTokenizedPaymentTransactionResult initPaymentSession(@HeaderParam("X-CIS-Client-Ref")
                                                        java.lang.String xCisClientRef,
                                                        @HeaderParam("X-tenantId")
                                                        java.lang.String tenantId,
                                                        CisPaymentSessionInitRequest cisPaymentSessionInitRequest)

paymentOrderSetup

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/authorizationsgroups/{authGroupId}/authorizations")
CisTokenizedPaymentTransactionResult paymentOrderSetup(@HeaderParam("X-CIS-Client-Ref")
                                                       java.lang.String xCisClientRef,
                                                       @HeaderParam("X-tenantId")
                                                       java.lang.String tenantId,
                                                       @PathParam("authGroupId")
                                                       java.lang.String authGroupId,
                                                       CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)

tokenizedPaymentAuthorization

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/authorizationsgroups")
CisTokenizedPaymentTransactionResult tokenizedPaymentAuthorization(@HeaderParam("X-CIS-Client-Ref")
                                                                   java.lang.String xCisClientRef,
                                                                   @HeaderParam("X-tenantId")
                                                                   java.lang.String tenantId,
                                                                   CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)

tokenizedPaymentCapture

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/authorizationsgroups/{authGroupId}/authorizations/{authId}/captures")
CisTokenizedPaymentTransactionResult tokenizedPaymentCapture(@HeaderParam("X-CIS-Client-Ref")
                                                             java.lang.String xCisClientRef,
                                                             @HeaderParam("X-tenantId")
                                                             java.lang.String tenantId,
                                                             @PathParam("authGroupId")
                                                             java.lang.String authGroupId,
                                                             @PathParam("authId")
                                                             java.lang.String authId,
                                                             CisTokenizedPaymentCapture cisTokenizedPaymentCapture)

tokenizedPaymentRefund

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/authorizationsgroups/{authGroupId}/authorizations/{authId}/captures/{transactionId}/refunds")
CisTokenizedPaymentTransactionResult tokenizedPaymentRefund(@HeaderParam("X-CIS-Client-Ref")
                                                            java.lang.String xCisClientRef,
                                                            @HeaderParam("X-tenantId")
                                                            java.lang.String tenantId,
                                                            @PathParam("authGroupId")
                                                            java.lang.String authGroupId,
                                                            @PathParam("authId")
                                                            java.lang.String authId,
                                                            @PathParam("transactionId")
                                                            java.lang.String transactionId,
                                                            CisTokenizedPaymentRefund cisTokenizedPaymentRefund)

tokenizedPaymentReverse

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/authorizationsgroups/{authGroupId}/authorizations/{authId}/reverses")
CisTokenizedPaymentTransactionResult tokenizedPaymentReverse(@HeaderParam("X-CIS-Client-Ref")
                                                             java.lang.String xCisClientRef,
                                                             @HeaderParam("X-tenantId")
                                                             java.lang.String tenantId,
                                                             @PathParam("authGroupId")
                                                             java.lang.String authGroupId,
                                                             @PathParam("authId")
                                                             java.lang.String authId,
                                                             CisTokenizedPaymentReverse cisTokenizedPaymentReverse)