Package 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	Description
PaymentsClient(ApiResource parent, Map<String,String> pathContext)

Method Summary

Modifier and Type	Method	Description
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
CreatePaymentResponse	createPayment(CreatePaymentRequest body)	Resource /v2/{merchantId}/payments - Create payment
CreatePaymentResponse	createPayment(CreatePaymentRequest body, CallContext context)	Resource /v2/{merchantId}/payments - Create payment
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
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

getClientHeaders, instantiateUri

Methods inherited from class java.lang.Object

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

Constructor Details

PaymentsClient

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

Method Details

createPayment

public CreatePaymentResponse createPayment(CreatePaymentRequest body)

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

Specified by:

createPayment in interface PaymentsClientInterface

Parameters:

body - CreatePaymentRequest

Returns:

CreatePaymentResponse

createPayment

public CreatePaymentResponse createPayment(CreatePaymentRequest body,
 CallContext context)

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

Specified by:

createPayment in interface PaymentsClientInterface

Parameters:

body - CreatePaymentRequest

context - CallContext

Returns:

CreatePaymentResponse

getPayment

public PaymentResponse getPayment(String paymentId)

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

Specified by:

getPayment in interface PaymentsClientInterface

Parameters:

paymentId - String

Returns:

PaymentResponse

getPayment

public PaymentResponse getPayment(String paymentId,
 CallContext context)

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

Specified by:

getPayment in interface PaymentsClientInterface

Parameters:

paymentId - String

context - CallContext

Returns:

PaymentResponse

getPaymentDetails

public PaymentDetailsResponse getPaymentDetails(String paymentId)

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

Specified by:

getPaymentDetails in interface PaymentsClientInterface

Parameters:

paymentId - String

Returns:

PaymentDetailsResponse

getPaymentDetails

public PaymentDetailsResponse getPaymentDetails(String paymentId,
 CallContext context)

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

Specified by:

getPaymentDetails in interface PaymentsClientInterface

Parameters:

paymentId - String

context - CallContext

Returns:

PaymentDetailsResponse

cancelPayment

public CancelPaymentResponse cancelPayment(String paymentId,
 CancelPaymentRequest body)

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

Specified by:

cancelPayment in interface PaymentsClientInterface

Parameters:

paymentId - String

body - CancelPaymentRequest

Returns:

CancelPaymentResponse

cancelPayment

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

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

Specified by:

cancelPayment in interface PaymentsClientInterface

Parameters:

paymentId - String

body - CancelPaymentRequest

context - CallContext

Returns:

CancelPaymentResponse

capturePayment

public CaptureResponse capturePayment(String paymentId,
 CapturePaymentRequest body)

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

Specified by:

capturePayment in interface PaymentsClientInterface

Parameters:

paymentId - String

body - CapturePaymentRequest

Returns:

CaptureResponse

capturePayment

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

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

Specified by:

capturePayment in interface PaymentsClientInterface

Parameters:

paymentId - String

body - CapturePaymentRequest

context - CallContext

Returns:

CaptureResponse

refundPayment

public RefundResponse refundPayment(String paymentId,
 RefundRequest body)

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

Specified by:

refundPayment in interface PaymentsClientInterface

Parameters:

paymentId - String

body - RefundRequest

Returns:

RefundResponse

refundPayment

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

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

Specified by:

refundPayment in interface PaymentsClientInterface

Parameters:

paymentId - String

body - RefundRequest

context - CallContext

Returns:

RefundResponse

subsequentPayment

public SubsequentPaymentResponse subsequentPayment(String paymentId,
 SubsequentPaymentRequest body)

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

Specified by:

subsequentPayment in interface PaymentsClientInterface

Parameters:

paymentId - String

body - SubsequentPaymentRequest

Returns:

SubsequentPaymentResponse

subsequentPayment

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

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

Specified by:

subsequentPayment in interface PaymentsClientInterface

Parameters:

paymentId - String

body - SubsequentPaymentRequest

context - CallContext

Returns:

SubsequentPaymentResponse