Package cz.gopay.api.v3

Interface PaymentClient

public interface PaymentClient

Author:

Zbynek Novak novak.zbynek@gmail.com

Method Summary

Modifier and Type	Method	Description
PaymentResult	capturePayment(AuthHeader authHeader, Long id)
PaymentResult	capturePayment(AuthHeader authHeader, Long id, CapturePayment capturePayment)
Payment	createPayment(AuthHeader authHeader, BasePayment createPayment)
Payment	createRecurrentPayment(AuthHeader authHeader, Long id, NextPayment createPayment)
SupercashCoupon	createSupercashCoupon(AuthHeader authHeader, SupercashCouponRequest couponRequest)
SupercashBatchResult	createSupercashCouponBatch(AuthHeader authHeader, SupercashBatchRequest batchRequest)
List<EETReceipt>	findEETReceiptsByFilter(AuthHeader authHeader, EETReceiptFilter filter)
SupercashBatch	findSupercashCoupons(AuthHeader authHeader, Long goId, String paymentSessionIds)
List<EETReceipt>	getEETReceiptByPaymentId(AuthHeader authHeader, Long id)
Payment	getPayment(AuthHeader authHeader, Long id)
PaymentInstrumentRoot	getPaymentInstruments(AuthHeader authHeader, Long goId, Currency currency)
byte[]	getStatement(AuthHeader authHeader, AccountStatement accountStatement)
SupercashPayment	getSupercashCoupon(AuthHeader authHeader, Long couponId)
SupercashBatch	getSupercashCouponBatch(AuthHeader authHeader, Long goId, Long batchId)
SupercashBatchState	getSupercashCouponBatchStatus(AuthHeader authHeader, Long batchId)
PaymentResult	refundPayment(AuthHeader authHeader, Long id, RefundPayment refundPayment)
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("/payments/payment")
@Produces({"application/json","application/xml"})
@Consumes("application/json")
Payment createPayment(@BeanParam
                      AuthHeader authHeader,
                      BasePayment createPayment)

refundPayment

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

refundPayment

@POST
@Path("/payments/payment/{id}/refund")
@Produces({"application/json","application/xml"})
@Consumes("application/json")
PaymentResult refundPayment(@BeanParam
                            AuthHeader authHeader,
                            @PathParam("id")
                            Long id,
                            RefundPayment refundPayment)

createRecurrentPayment

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

voidRecurrence

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

capturePayment

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

capturePayment

@POST
@Path("/payments/payment/{id}/capture")
@Produces({"application/json","application/xml"})
@Consumes("application/json")
PaymentResult capturePayment(@BeanParam
                             AuthHeader authHeader,
                             @PathParam("id")
                             Long id,
                             CapturePayment capturePayment)

voidAuthorization

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

getPayment

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

getPaymentInstruments

@GET
@Path("eshops/eshop/{goid}/payment-instruments/{currency}")
@Produces("application/json")
@Consumes("application/x-www-form-urlencoded")
PaymentInstrumentRoot getPaymentInstruments(@BeanParam
                                            AuthHeader authHeader,
                                            @PathParam("goid")
                                            Long goId,
                                            @PathParam("currency")
                                            Currency currency)

getStatement

@POST
@Path("accounts/account-statement")
@Produces("application/octet-stream")
@Consumes("application/json")
byte[] getStatement(@BeanParam
                    AuthHeader authHeader,
                    AccountStatement accountStatement)

findEETReceiptsByFilter

@POST
@Path("/eet-receipts")
@Produces({"application/json","application/xml"})
@Consumes("application/json")
List<EETReceipt> findEETReceiptsByFilter(@BeanParam
                                         AuthHeader authHeader,
                                         EETReceiptFilter filter)

getEETReceiptByPaymentId

@GET
@Path("/payments/payment/{id}/eet-receipts")
@Produces({"application/json","application/xml"})
@Consumes("application/json")
List<EETReceipt> getEETReceiptByPaymentId(@BeanParam
                                          AuthHeader authHeader,
                                          @PathParam("id")
                                          Long id)

createSupercashCoupon

@POST
@Path("/supercash/coupon")
@Produces({"application/json","application/xml"})
@Consumes("application/json")
SupercashCoupon createSupercashCoupon(@BeanParam
                                      AuthHeader authHeader,
                                      SupercashCouponRequest couponRequest)

createSupercashCouponBatch

@POST
@Path("/supercash/coupon/batch")
@Produces({"application/json","application/xml"})
@Consumes("application/json")
SupercashBatchResult createSupercashCouponBatch(@BeanParam
                                                AuthHeader authHeader,
                                                SupercashBatchRequest batchRequest)

getSupercashCouponBatchStatus

@GET
@Path("/batch/{batch_id}")
@Produces({"application/json","application/xml"})
@Consumes("application/x-www-form-urlencoded")
SupercashBatchState getSupercashCouponBatchStatus(@BeanParam
                                                  AuthHeader authHeader,
                                                  @PathParam("batch_id")
                                                  Long batchId)

getSupercashCouponBatch

@GET
@Path("/supercash/coupon/find")
@Produces({"application/json","application/xml"})
@Consumes("application/x-www-form-urlencoded")
SupercashBatch getSupercashCouponBatch(@BeanParam
                                       AuthHeader authHeader,
                                       @QueryParam("go_id")
                                       Long goId,
                                       @QueryParam("batch_request_id")
                                       Long batchId)

findSupercashCoupons

@GET
@Path("/supercash/coupon/find")
@Produces({"application/json","application/xml"})
@Consumes("application/x-www-form-urlencoded")
SupercashBatch findSupercashCoupons(@BeanParam
                                    AuthHeader authHeader,
                                    @QueryParam("go_id")
                                    Long goId,
                                    @QueryParam("payment_session_id_list")
                                    String paymentSessionIds)

getSupercashCoupon

@GET
@Path("/supercash/coupon/{coupon_id}")
@Produces({"application/json","application/xml"})
@Consumes("application/x-www-form-urlencoded")
SupercashPayment getSupercashCoupon(@BeanParam
                                    AuthHeader authHeader,
                                    @PathParam("coupon_id")
                                    Long couponId)