Package com.onlinepayments.merchant.products

Interface ProductsClientInterface

All Known Implementing Classes:
ProductsClient
public interface ProductsClientInterface
Products client. Thread-safe.

  • Method Details

    • getPaymentProducts

      GetPaymentProductsResponse getPaymentProducts(GetPaymentProductsParams query)
      Resource /v2/{merchantId}/products - Get payment products
      Parameters:
      query - GetPaymentProductsParams
      Returns:
      GetPaymentProductsResponse
      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)
      PlatformException - 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
      Parameters:
      query - GetPaymentProductsParams
      context - CallContext
      Returns:
      GetPaymentProductsResponse
      Throws:
      IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)
      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)
      PlatformException - 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
      Parameters:
      paymentProductId - Integer
      query - GetPaymentProductParams
      Returns:
      PaymentProduct
      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)
      PlatformException - 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
      Parameters:
      paymentProductId - Integer
      query - GetPaymentProductParams
      context - CallContext
      Returns:
      PaymentProduct
      Throws:
      IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)
      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)
      PlatformException - 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
      Parameters:
      paymentProductId - Integer
      query - GetPaymentProductNetworksParams
      Returns:
      PaymentProductNetworksResponse
      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)
      PlatformException - 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
      Parameters:
      paymentProductId - Integer
      query - GetPaymentProductNetworksParams
      context - CallContext
      Returns:
      PaymentProductNetworksResponse
      Throws:
      IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)
      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)
      PlatformException - 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
      Parameters:
      paymentProductId - Integer
      query - GetProductDirectoryParams
      Returns:
      ProductDirectory
      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)
      PlatformException - 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
      Parameters:
      paymentProductId - Integer
      query - GetProductDirectoryParams
      context - CallContext
      Returns:
      ProductDirectory
      Throws:
      IdempotenceException - if an idempotent request caused a conflict (HTTP status code 409)
      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)
      PlatformException - 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