com.onlinepayments.merchant.payments

Interface PaymentsClientInterface

All Known Implementing Classes:

PaymentsClient

public interface PaymentsClientInterface

Payments client. Thread-safe.

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

Method Detail

createPayment

CreatePaymentResponse createPayment(CreatePaymentRequest body)

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

Throws:

DeclinedPaymentException - if the payment platform declined / rejected the payment. The payment result will be available from the exception.

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

createPayment

CreatePaymentResponse createPayment(CreatePaymentRequest body,
                                    CallContext context)

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

Throws:

DeclinedPaymentException - if the payment platform declined / rejected the payment. The payment result will be available from the exception.

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

getPayment

PaymentResponse getPayment(String paymentId)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

getPayment

PaymentResponse getPayment(String paymentId,
                           CallContext context)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

completePayment

CompletePaymentResponse completePayment(String paymentId,
                                        CompletePaymentRequest body)

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

Throws:

DeclinedPaymentException - if the payment platform declined / rejected the payment. The payment result will be available from the exception.

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

completePayment

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

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

Throws:

DeclinedPaymentException - if the payment platform declined / rejected the payment. The payment result will be available from the exception.

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

cancelPayment

CancelPaymentResponse cancelPayment(String paymentId)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

cancelPayment

CancelPaymentResponse cancelPayment(String paymentId,
                                    CallContext context)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

cancelPayment

CancelPaymentResponse cancelPayment(String paymentId,
                                    CancelPaymentRequest body)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

cancelPayment

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

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

subsequentPayment

SubsequentPaymentResponse subsequentPayment(String paymentId,
                                            SubsequentPaymentRequest body)

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

Throws:

DeclinedPaymentException - if the payment platform declined / rejected the payment. The payment result will be available from the exception.

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

subsequentPayment

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

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

Throws:

DeclinedPaymentException - if the payment platform declined / rejected the payment. The payment result will be available from the exception.

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

refundPayment

RefundResponse refundPayment(String paymentId,
                             RefundRequest body)

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

Throws:

DeclinedRefundException - if the payment platform declined / rejected the refund. The refund result will be available from the exception.

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

refundPayment

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

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

Throws:

DeclinedRefundException - if the payment platform declined / rejected the refund. The refund result will be available from the exception.

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

capturePayment

CaptureResponse capturePayment(String paymentId,
                               CapturePaymentRequest body)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

capturePayment

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

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

getCaptures

CapturesResponse getCaptures(String paymentId)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

getCaptures

CapturesResponse getCaptures(String paymentId,
                             CallContext context)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

getPaymentDetails

PaymentDetailsResponse getPaymentDetails(String paymentId)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

getPaymentDetails

PaymentDetailsResponse getPaymentDetails(String paymentId,
                                         CallContext context)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

getRefunds

RefundsResponse getRefunds(String paymentId)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error

getRefunds

RefundsResponse getRefunds(String paymentId,
                           CallContext context)

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

Throws:

ValidationException - if the request was not correct and couldn't be processed (HTTP status code 400)

AuthorizationException - if the request was not allowed (HTTP status code 403)

IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)

ReferenceException - if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code 404, 409 or 410)

PaymentPlatformException - if something went wrong at the payment platform, the payment platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

ApiException - if the payment platform returned any other error