com.onlinepayments.merchant.products

Interface ProductsClientInterface

All Known Implementing Classes:

ProductsClient

public interface ProductsClientInterface

Products client. Thread-safe.

Method Summary

Modifier and Type	Method and Description
PaymentProduct	getPaymentProduct(Integer paymentProductId, GetPaymentProductParams query) Resource /v2/{merchantId}/products/{paymentProductId} - Get payment product
PaymentProduct	getPaymentProduct(Integer paymentProductId, GetPaymentProductParams query, CallContext context) Resource /v2/{merchantId}/products/{paymentProductId} - Get payment product
PaymentProductNetworksResponse	getPaymentProductNetworks(Integer paymentProductId, GetPaymentProductNetworksParams query) Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks
PaymentProductNetworksResponse	getPaymentProductNetworks(Integer paymentProductId, GetPaymentProductNetworksParams query, CallContext context) Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks
GetPaymentProductsResponse	getPaymentProducts(GetPaymentProductsParams query) Resource /v2/{merchantId}/products - Get payment products
GetPaymentProductsResponse	getPaymentProducts(GetPaymentProductsParams query, CallContext context) Resource /v2/{merchantId}/products - Get payment products
ProductDirectory	getProductDirectory(Integer paymentProductId, GetProductDirectoryParams query) Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory
ProductDirectory	getProductDirectory(Integer paymentProductId, GetProductDirectoryParams query, CallContext context) Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory

Method Detail

getPaymentProducts

GetPaymentProductsResponse getPaymentProducts(GetPaymentProductsParams query)

Resource /v2/{merchantId}/products - Get payment products

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

getPaymentProducts

GetPaymentProductsResponse getPaymentProducts(GetPaymentProductsParams query,
                                              CallContext context)

Resource /v2/{merchantId}/products - Get payment products

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

getPaymentProduct

PaymentProduct getPaymentProduct(Integer paymentProductId,
                                 GetPaymentProductParams query)

Resource /v2/{merchantId}/products/{paymentProductId} - Get payment product

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

getPaymentProduct

PaymentProduct getPaymentProduct(Integer paymentProductId,
                                 GetPaymentProductParams query,
                                 CallContext context)

Resource /v2/{merchantId}/products/{paymentProductId} - Get payment product

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

getProductDirectory

ProductDirectory getProductDirectory(Integer paymentProductId,
                                     GetProductDirectoryParams query)

Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory

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

getProductDirectory

ProductDirectory getProductDirectory(Integer paymentProductId,
                                     GetProductDirectoryParams query,
                                     CallContext context)

Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory

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

getPaymentProductNetworks

PaymentProductNetworksResponse getPaymentProductNetworks(Integer paymentProductId,
                                                         GetPaymentProductNetworksParams query)

Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks

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

getPaymentProductNetworks

PaymentProductNetworksResponse getPaymentProductNetworks(Integer paymentProductId,
                                                         GetPaymentProductNetworksParams query,
                                                         CallContext context)

Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks

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