cz.gopay.api.v3

Interface PaymentClient

public interface PaymentClient

Author:

Zbynek Novak novak.zbynek@gmail.com

Method Summary

Modifier and Type	Method and Description
PaymentResult	capturePayment(AuthHeader authHeader, Long id)
Payment	createPayment(AuthHeader authHeader, BasePayment createPayment)
Payment	createRecurrentPayment(AuthHeader authHeader, Long id, NextPayment createPayment)
Payment	getPayment(AuthHeader authHeader, Long id)
PaymentResult	refundPayment(AuthHeader authHeader, Long id, Long amount)
PaymentResult	voidAuthorization(AuthHeader authHeader, Long id)
PaymentResult	voidRecurrence(AuthHeader authHeader, Long id)

Method Detail

createPayment

@POST
 @Path(value="/payments/payment")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value="application/json")
Payment createPayment(@BeanParam
                                                                                                                                                            AuthHeader authHeader,
                                                                                                                                                            BasePayment createPayment)

refundPayment

@POST
 @Path(value="/payments/payment/{id}/refund")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value="application/x-www-form-urlencoded")
PaymentResult refundPayment(@BeanParam
                                                                                                                                                                                               AuthHeader authHeader,
                                                                                                                                                                                               @PathParam(value="id")
                                                                                                                                                                                               Long id,
                                                                                                                                                                                               @FormParam(value="amount")
                                                                                                                                                                                               Long amount)

createRecurrentPayment

@POST
 @Path(value="/payments/payment/{id}/create-recurrence")
 @Consumes(value="application/json")
 @Produces(value={"application/json","application/xml"})
Payment createRecurrentPayment(@BeanParam
                                                                                                                                                                                            AuthHeader authHeader,
                                                                                                                                                                                            @PathParam(value="id")
                                                                                                                                                                                            Long id,
                                                                                                                                                                                            NextPayment createPayment)

voidRecurrence

@POST
 @Path(value="/payments/payment/{id}/void-recurrence")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value="application/x-www-form-urlencoded")
PaymentResult voidRecurrence(@BeanParam
                                                                                                                                                                                                         AuthHeader authHeader,
                                                                                                                                                                                                         @PathParam(value="id")
                                                                                                                                                                                                         Long id)

capturePayment

@POST
 @Path(value="/payments/payment/{id}/capture")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value="application/x-www-form-urlencoded")
PaymentResult capturePayment(@BeanParam
                                                                                                                                                                                                 AuthHeader authHeader,
                                                                                                                                                                                                 @PathParam(value="id")
                                                                                                                                                                                                 Long id)

voidAuthorization

@POST
 @Path(value="/payments/payment/{id}/void-authorization")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value="application/x-www-form-urlencoded")
PaymentResult voidAuthorization(@BeanParam
                                                                                                                                                                                                               AuthHeader authHeader,
                                                                                                                                                                                                               @PathParam(value="id")
                                                                                                                                                                                                               Long id)

getPayment

@GET
 @Path(value="/payments/payment/{id}")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value="application/x-www-form-urlencoded")
Payment getPayment(@BeanParam
                                                                                                                                                                              AuthHeader authHeader,
                                                                                                                                                                              @PathParam(value="id")
                                                                                                                                                                              Long id)