Package com.onlinepayments.merchant.hostedcheckout

Interface HostedCheckoutClientInterface

All Known Implementing Classes:
HostedCheckoutClient
public interface HostedCheckoutClientInterface
HostedCheckout client. Thread-safe.

  • Method Details

    • createHostedCheckout

      CreateHostedCheckoutResponse createHostedCheckout(CreateHostedCheckoutRequest body)
      Resource /v2/{merchantId}/hostedcheckouts - Create hosted checkout
      Parameters:
      body - CreateHostedCheckoutRequest
      Returns:
      CreateHostedCheckoutResponse
      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

    • createHostedCheckout

      CreateHostedCheckoutResponse createHostedCheckout(CreateHostedCheckoutRequest body, CallContext context)
      Resource /v2/{merchantId}/hostedcheckouts - Create hosted checkout
      Parameters:
      body - CreateHostedCheckoutRequest
      context - CallContext
      Returns:
      CreateHostedCheckoutResponse
      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

    • getHostedCheckout

      GetHostedCheckoutResponse getHostedCheckout(String hostedCheckoutId)
      Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status
      Parameters:
      hostedCheckoutId - String
      Returns:
      GetHostedCheckoutResponse
      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

    • getHostedCheckout

      GetHostedCheckoutResponse getHostedCheckout(String hostedCheckoutId, CallContext context)
      Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status
      Parameters:
      hostedCheckoutId - String
      context - CallContext
      Returns:
      GetHostedCheckoutResponse
      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