Package com.onlinepayments.merchant.productgroups

Interface ProductGroupsClientInterface

All Known Implementing Classes:
ProductGroupsClient
public interface ProductGroupsClientInterface
ProductGroups client. Thread-safe.

  • Method Details

    • getProductGroups

      GetPaymentProductGroupsResponse getProductGroups(GetProductGroupsParams query)
      Resource /v2/{merchantId}/productgroups - Get product groups
      Parameters:
      query - GetProductGroupsParams
      Returns:
      GetPaymentProductGroupsResponse
      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

    • getProductGroups

      GetPaymentProductGroupsResponse getProductGroups(GetProductGroupsParams query, CallContext context)
      Resource /v2/{merchantId}/productgroups - Get product groups
      Parameters:
      query - GetProductGroupsParams
      context - CallContext
      Returns:
      GetPaymentProductGroupsResponse
      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

    • getProductGroup

      PaymentProductGroup getProductGroup(String paymentProductGroupId, GetProductGroupParams query)
      Resource /v2/{merchantId}/productgroups/{paymentProductGroupId} - Get product group
      Parameters:
      paymentProductGroupId - String
      query - GetProductGroupParams
      Returns:
      PaymentProductGroup
      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

    • getProductGroup

      PaymentProductGroup getProductGroup(String paymentProductGroupId, GetProductGroupParams query, CallContext context)
      Resource /v2/{merchantId}/productgroups/{paymentProductGroupId} - Get product group
      Parameters:
      paymentProductGroupId - String
      query - GetProductGroupParams
      context - CallContext
      Returns:
      PaymentProductGroup
      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