Package com.onlinepayments.merchant.services

Interface ServicesClientInterface

All Known Implementing Classes:
ServicesClient
public interface ServicesClientInterface
Services client. Thread-safe.

  • Method Details

    • testConnection

      TestConnection testConnection()
      Resource /v2/{merchantId}/services/testconnection - Test connection
      Returns:
      TestConnection
      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

    • testConnection

      TestConnection testConnection(CallContext context)
      Resource /v2/{merchantId}/services/testconnection - Test connection
      Parameters:
      context - CallContext
      Returns:
      TestConnection
      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

    • getIINDetails

      GetIINDetailsResponse getIINDetails(GetIINDetailsRequest body)
      Resource /v2/{merchantId}/services/getIINdetails - Get IIN details
      Parameters:
      body - GetIINDetailsRequest
      Returns:
      GetIINDetailsResponse
      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

    • getIINDetails

      GetIINDetailsResponse getIINDetails(GetIINDetailsRequest body, CallContext context)
      Resource /v2/{merchantId}/services/getIINdetails - Get IIN details
      Parameters:
      body - GetIINDetailsRequest
      context - CallContext
      Returns:
      GetIINDetailsResponse
      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

    • getDccRateInquiry

      CurrencyConversionResponse getDccRateInquiry(CurrencyConversionRequest body)
      Resource /v2/{merchantId}/services/dccrate - Get currency conversion quote
      Parameters:
      body - CurrencyConversionRequest
      Returns:
      CurrencyConversionResponse
      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

    • getDccRateInquiry

      CurrencyConversionResponse getDccRateInquiry(CurrencyConversionRequest body, CallContext context)
      Resource /v2/{merchantId}/services/dccrate - Get currency conversion quote
      Parameters:
      body - CurrencyConversionRequest
      context - CallContext
      Returns:
      CurrencyConversionResponse
      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

    • surchargeCalculation

      CalculateSurchargeResponse surchargeCalculation(CalculateSurchargeRequest body)
      Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation
      Parameters:
      body - CalculateSurchargeRequest
      Returns:
      CalculateSurchargeResponse
      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

    • surchargeCalculation

      CalculateSurchargeResponse surchargeCalculation(CalculateSurchargeRequest body, CallContext context)
      Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation
      Parameters:
      body - CalculateSurchargeRequest
      context - CallContext
      Returns:
      CalculateSurchargeResponse
      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