Class: OnlinePayments::SDK::Merchant::HostedCheckout::HostedCheckoutClient

Inherits:

ApiResource

• Object
• ApiResource
• OnlinePayments::SDK::Merchant::HostedCheckout::HostedCheckoutClient

Defined in:

lib/onlinepayments/sdk/merchant/hostedcheckout/hosted_checkout_client.rb

Overview

HostedCheckout client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary

• #create_hosted_checkout(body, context = nil) ⇒ OnlinePayments::SDK::Domain::CreateHostedCheckoutResponse

  Resource /v2/{merchantId}/hostedcheckouts.

• #get_hosted_checkout(hosted_checkout_id, context = nil) ⇒ OnlinePayments::SDK::Domain::GetHostedCheckoutResponse

  Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId}.

• #initialize(parent, path_context = nil) ⇒ HostedCheckoutClient constructor

  A new instance of HostedCheckoutClient.

Constructor Details

#initialize(parent, path_context = nil) ⇒ HostedCheckoutClient

Returns a new instance of HostedCheckoutClient.

Parameters:

• parent (OnlinePayments::SDK::ApiResource)
• path_context (Hash, nil) (defaults to: nil)

# File 'lib/onlinepayments/sdk/merchant/hostedcheckout/hosted_checkout_client.rb', line 20

def initialize(parent, path_context = nil)
  super(parent, path_context)
end

Instance Method Details

#create_hosted_checkout(body, context = nil) ⇒ OnlinePayments::SDK::Domain::CreateHostedCheckoutResponse

Resource /v2/{merchantId}/hostedcheckouts

Parameters:

• body (OnlinePayments::SDK::Domain::CreateHostedCheckoutRequest)
• context (OnlinePayments::SDK::CallContext) (defaults to: nil)

Returns:

• (OnlinePayments::SDK::Domain::CreateHostedCheckoutResponse)

Raises:

• (OnlinePayments::SDK::ValidationException) —

  if the request was not correct and couldn’t be processed (HTTP status code 400)

• (OnlinePayments::SDK::AuthorizationException) —

  if the request was not allowed (HTTP status code 403)

• (OnlinePayments::SDK::IdempotenceException) —

  if an idempotent request caused a conflict (HTTP status code 409)

• (OnlinePayments::SDK::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)

• (OnlinePayments::SDK::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)

• (OnlinePayments::SDK::ApiException) —

  if the payment platform returned any other error

# File 'lib/onlinepayments/sdk/merchant/hostedcheckout/hosted_checkout_client.rb', line 37

def create_hosted_checkout(body, context = nil)
  uri = instantiate_uri('/v2/{merchantId}/hostedcheckouts')
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    OnlinePayments::SDK::Domain::CreateHostedCheckoutResponse,
    context
  )
rescue ResponseException => e
  error_type = OnlinePayments::SDK::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#get_hosted_checkout(hosted_checkout_id, context = nil) ⇒ OnlinePayments::SDK::Domain::GetHostedCheckoutResponse

Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId}

Parameters:

• hosted_checkout_id (String)
• context (OnlinePayments::SDK::CallContext) (defaults to: nil)

Returns:

• (OnlinePayments::SDK::Domain::GetHostedCheckoutResponse)

Raises:

• (OnlinePayments::SDK::ValidationException) —

  if the request was not correct and couldn’t be processed (HTTP status code 400)

• (OnlinePayments::SDK::AuthorizationException) —

  if the request was not allowed (HTTP status code 403)

• (OnlinePayments::SDK::IdempotenceException) —

  if an idempotent request caused a conflict (HTTP status code 409)

• (OnlinePayments::SDK::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)

• (OnlinePayments::SDK::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)

• (OnlinePayments::SDK::ApiException) —

  if the payment platform returned any other error

# File 'lib/onlinepayments/sdk/merchant/hostedcheckout/hosted_checkout_client.rb', line 66

def get_hosted_checkout(hosted_checkout_id, context = nil)
  path_context = {
    'hostedCheckoutId'.freeze => hosted_checkout_id,
  }
  uri = instantiate_uri('/v2/{merchantId}/hostedcheckouts/{hostedCheckoutId}', path_context)
  @communicator.get(
    uri,
    client_headers,
    nil,
    OnlinePayments::SDK::Domain::GetHostedCheckoutResponse,
    context
  )
rescue ResponseException => e
  error_type = OnlinePayments::SDK::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end