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)
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, Long amount)
PaymentResult	refundPayment(AuthHeader authHeader, Long id, RefundPayment refundPayment)
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)

refundPayment

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

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)

capturePayment

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

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)

getPaymentInstruments

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

getStatement

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

findEETReceiptsByFilter

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

getEETReceiptByPaymentId

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

createSupercashCoupon

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

createSupercashCouponBatch

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

getSupercashCouponBatchStatus

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

getSupercashCouponBatch

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

findSupercashCoupons

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

getSupercashCoupon

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