com.onlinepayments.merchant.payments

Class PaymentsClient

java.lang.Object

com.onlinepayments.ApiResource

com.onlinepayments.merchant.payments.PaymentsClient

All Implemented Interfaces:

PaymentsClientInterface

public class PaymentsClient
extends ApiResource
implements PaymentsClientInterface

Payments client. Thread-safe.

Field Summary

Fields inherited from class com.onlinepayments.ApiResource

clientMetaInfo, communicator

Constructor Summary

Constructors

Constructor and Description
PaymentsClient(ApiResource parent, Map<String,String> pathContext)

Method Summary

Modifier and Type	Method and Description
CancelPaymentResponse	cancelPayment(String paymentId) Resource /v2/{merchantId}/payments/{paymentId}/cancel - Cancel payment
CancelPaymentResponse	cancelPayment(String paymentId, CallContext context) Resource /v2/{merchantId}/payments/{paymentId}/cancel - Cancel payment
CancelPaymentResponse	cancelPayment(String paymentId, CancelPaymentRequest body) Resource /v2/{merchantId}/payments/{paymentId}/cancel - Cancel payment
CancelPaymentResponse	cancelPayment(String paymentId, CancelPaymentRequest body, CallContext context) Resource /v2/{merchantId}/payments/{paymentId}/cancel - Cancel payment
CaptureResponse	capturePayment(String paymentId, CapturePaymentRequest body) Resource /v2/{merchantId}/payments/{paymentId}/capture - Capture payment
CaptureResponse	capturePayment(String paymentId, CapturePaymentRequest body, CallContext context) Resource /v2/{merchantId}/payments/{paymentId}/capture - Capture payment
CompletePaymentResponse	completePayment(String paymentId, CompletePaymentRequest body) Resource /v2/{merchantId}/payments/{paymentId}/complete - Complete payment
CompletePaymentResponse	completePayment(String paymentId, CompletePaymentRequest body, CallContext context) Resource /v2/{merchantId}/payments/{paymentId}/complete - Complete payment
CreatePaymentResponse	createPayment(CreatePaymentRequest body) Resource /v2/{merchantId}/payments - Create payment
CreatePaymentResponse	createPayment(CreatePaymentRequest body, CallContext context) Resource /v2/{merchantId}/payments - Create payment
CapturesResponse	getCaptures(String paymentId) Resource /v2/{merchantId}/payments/{paymentId}/captures - Get Captures Api
CapturesResponse	getCaptures(String paymentId, CallContext context) Resource /v2/{merchantId}/payments/{paymentId}/captures - Get Captures Api
PaymentResponse	getPayment(String paymentId) Resource /v2/{merchantId}/payments/{paymentId} - Get payment
PaymentResponse	getPayment(String paymentId, CallContext context) Resource /v2/{merchantId}/payments/{paymentId} - Get payment
PaymentDetailsResponse	getPaymentDetails(String paymentId) Resource /v2/{merchantId}/payments/{paymentId}/details - Get payment details
PaymentDetailsResponse	getPaymentDetails(String paymentId, CallContext context) Resource /v2/{merchantId}/payments/{paymentId}/details - Get payment details
RefundsResponse	getRefunds(String paymentId) Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get Refunds Api
RefundsResponse	getRefunds(String paymentId, CallContext context) Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get Refunds Api
RefundResponse	refundPayment(String paymentId, RefundRequest body) Resource /v2/{merchantId}/payments/{paymentId}/refund - Refund payment
RefundResponse	refundPayment(String paymentId, RefundRequest body, CallContext context) Resource /v2/{merchantId}/payments/{paymentId}/refund - Refund payment
SubsequentPaymentResponse	subsequentPayment(String paymentId, SubsequentPaymentRequest body) Resource /v2/{merchantId}/payments/{paymentId}/subsequent - Subsequent payment
SubsequentPaymentResponse	subsequentPayment(String paymentId, SubsequentPaymentRequest body, CallContext context) Resource /v2/{merchantId}/payments/{paymentId}/subsequent - Subsequent payment

Methods inherited from class com.onlinepayments.ApiResource

createException, getClientHeaders, instantiateUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaymentsClient

public PaymentsClient(ApiResource parent,
                      Map<String,String> pathContext)

Method Detail

createPayment

public CreatePaymentResponse createPayment(CreatePaymentRequest body)

Resource /v2/{merchantId}/payments - Create payment

Specified by:

createPayment in interface PaymentsClientInterface

createPayment

public CreatePaymentResponse createPayment(CreatePaymentRequest body,
                                           CallContext context)

Resource /v2/{merchantId}/payments - Create payment

Specified by:

createPayment in interface PaymentsClientInterface

getPayment

public PaymentResponse getPayment(String paymentId)

Resource /v2/{merchantId}/payments/{paymentId} - Get payment

Specified by:

getPayment in interface PaymentsClientInterface

getPayment

public PaymentResponse getPayment(String paymentId,
                                  CallContext context)

Resource /v2/{merchantId}/payments/{paymentId} - Get payment

Specified by:

getPayment in interface PaymentsClientInterface

completePayment

public CompletePaymentResponse completePayment(String paymentId,
                                               CompletePaymentRequest body)

Resource /v2/{merchantId}/payments/{paymentId}/complete - Complete payment

Specified by:

completePayment in interface PaymentsClientInterface

completePayment

public CompletePaymentResponse completePayment(String paymentId,
                                               CompletePaymentRequest body,
                                               CallContext context)

Resource /v2/{merchantId}/payments/{paymentId}/complete - Complete payment

Specified by:

completePayment in interface PaymentsClientInterface

cancelPayment

public CancelPaymentResponse cancelPayment(String paymentId)

Resource /v2/{merchantId}/payments/{paymentId}/cancel - Cancel payment

Specified by:

cancelPayment in interface PaymentsClientInterface

cancelPayment

public CancelPaymentResponse cancelPayment(String paymentId,
                                           CallContext context)

Resource /v2/{merchantId}/payments/{paymentId}/cancel - Cancel payment

Specified by:

cancelPayment in interface PaymentsClientInterface

cancelPayment

public CancelPaymentResponse cancelPayment(String paymentId,
                                           CancelPaymentRequest body)

Resource /v2/{merchantId}/payments/{paymentId}/cancel - Cancel payment

Specified by:

cancelPayment in interface PaymentsClientInterface

cancelPayment

public CancelPaymentResponse cancelPayment(String paymentId,
                                           CancelPaymentRequest body,
                                           CallContext context)

Resource /v2/{merchantId}/payments/{paymentId}/cancel - Cancel payment

Specified by:

cancelPayment in interface PaymentsClientInterface

subsequentPayment

public SubsequentPaymentResponse subsequentPayment(String paymentId,
                                                   SubsequentPaymentRequest body)

Resource /v2/{merchantId}/payments/{paymentId}/subsequent - Subsequent payment

Specified by:

subsequentPayment in interface PaymentsClientInterface

subsequentPayment

public SubsequentPaymentResponse subsequentPayment(String paymentId,
                                                   SubsequentPaymentRequest body,
                                                   CallContext context)

Resource /v2/{merchantId}/payments/{paymentId}/subsequent - Subsequent payment

Specified by:

subsequentPayment in interface PaymentsClientInterface

refundPayment

public RefundResponse refundPayment(String paymentId,
                                    RefundRequest body)

Resource /v2/{merchantId}/payments/{paymentId}/refund - Refund payment

Specified by:

refundPayment in interface PaymentsClientInterface

refundPayment

public RefundResponse refundPayment(String paymentId,
                                    RefundRequest body,
                                    CallContext context)

Resource /v2/{merchantId}/payments/{paymentId}/refund - Refund payment

Specified by:

refundPayment in interface PaymentsClientInterface

capturePayment

public CaptureResponse capturePayment(String paymentId,
                                      CapturePaymentRequest body)

Resource /v2/{merchantId}/payments/{paymentId}/capture - Capture payment

Specified by:

capturePayment in interface PaymentsClientInterface

capturePayment

public CaptureResponse capturePayment(String paymentId,
                                      CapturePaymentRequest body,
                                      CallContext context)

Resource /v2/{merchantId}/payments/{paymentId}/capture - Capture payment

Specified by:

capturePayment in interface PaymentsClientInterface

getCaptures

public CapturesResponse getCaptures(String paymentId)

Resource /v2/{merchantId}/payments/{paymentId}/captures - Get Captures Api

Specified by:

getCaptures in interface PaymentsClientInterface

getCaptures

public CapturesResponse getCaptures(String paymentId,
                                    CallContext context)

Resource /v2/{merchantId}/payments/{paymentId}/captures - Get Captures Api

Specified by:

getCaptures in interface PaymentsClientInterface

getPaymentDetails

public PaymentDetailsResponse getPaymentDetails(String paymentId)

Resource /v2/{merchantId}/payments/{paymentId}/details - Get payment details

Specified by:

getPaymentDetails in interface PaymentsClientInterface

getPaymentDetails

public PaymentDetailsResponse getPaymentDetails(String paymentId,
                                                CallContext context)

Resource /v2/{merchantId}/payments/{paymentId}/details - Get payment details

Specified by:

getPaymentDetails in interface PaymentsClientInterface

getRefunds

public RefundsResponse getRefunds(String paymentId)

Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get Refunds Api

Specified by:

getRefunds in interface PaymentsClientInterface

getRefunds

public RefundsResponse getRefunds(String paymentId,
                                  CallContext context)

Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get Refunds Api

Specified by:

getRefunds in interface PaymentsClientInterface