Class: Ingenico::Direct::SDK::Merchant::Payouts::PayoutsClient

Inherits:

ApiResource

• Object
• ApiResource
• Ingenico::Direct::SDK::Merchant::Payouts::PayoutsClient

Defined in:

lib/ingenico/direct/sdk/merchant/payouts/payouts_client.rb

Overview

Payouts client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary

• #create_payout(body, context = nil) ⇒ Ingenico::Direct::SDK::Domain::PayoutResponse

  Resource /v2/{merchantId}/payouts - Create payout.

• #get_payout(payout_id, context = nil) ⇒ Ingenico::Direct::SDK::Domain::PayoutResponse

  Resource /v2/{merchantId}/payouts/{payoutId} - Get payout.

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

  A new instance of PayoutsClient.

Constructor Details

#initialize(parent, path_context = nil) ⇒ PayoutsClient

Returns a new instance of PayoutsClient.

Parameters:

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

# File 'lib/ingenico/direct/sdk/merchant/payouts/payouts_client.rb', line 21

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

Instance Method Details

#create_payout(body, context = nil) ⇒ Ingenico::Direct::SDK::Domain::PayoutResponse

Resource /v2/{merchantId}/payouts - Create payout

Parameters:

• body (Ingenico::Direct::SDK::Domain::CreatePayoutRequest)
• context (Ingenico::Direct::SDK::CallContext) (defaults to: nil)

Returns:

• (Ingenico::Direct::SDK::Domain::PayoutResponse)

Raises:

• (Ingenico::Direct::SDK::ValidationException) —

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

• (Ingenico::Direct::SDK::AuthorizationException) —

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

• (Ingenico::Direct::SDK::IdempotenceException) —

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

• (Ingenico::Direct::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)

• (Ingenico::Direct::SDK::GlobalCollectException) —

  if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments 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)

• (Ingenico::Direct::SDK::ApiException) —

  if the Ingenico ePayments platform returned any other error

# File 'lib/ingenico/direct/sdk/merchant/payouts/payouts_client.rb', line 38

def create_payout(body, context = nil)
  uri = instantiate_uri('/v2/{merchantId}/payouts')
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Ingenico::Direct::SDK::Domain::PayoutResponse,
    context
  )
rescue ResponseException => e
  error_type = Ingenico::Direct::SDK::Domain::PayoutErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#get_payout(payout_id, context = nil) ⇒ Ingenico::Direct::SDK::Domain::PayoutResponse

Resource /v2/{merchantId}/payouts/{payoutId} - Get payout

Parameters:

• payout_id (String)
• context (Ingenico::Direct::SDK::CallContext) (defaults to: nil)

Returns:

• (Ingenico::Direct::SDK::Domain::PayoutResponse)

Raises:

• (Ingenico::Direct::SDK::ValidationException) —

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

• (Ingenico::Direct::SDK::AuthorizationException) —

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

• (Ingenico::Direct::SDK::IdempotenceException) —

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

• (Ingenico::Direct::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)

• (Ingenico::Direct::SDK::GlobalCollectException) —

  if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments 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)

• (Ingenico::Direct::SDK::ApiException) —

  if the Ingenico ePayments platform returned any other error

# File 'lib/ingenico/direct/sdk/merchant/payouts/payouts_client.rb', line 67

def get_payout(payout_id, context = nil)
  path_context = {
    'payoutId'.freeze => payout_id,
  }
  uri = instantiate_uri('/v2/{merchantId}/payouts/{payoutId}', path_context)
  @communicator.get(
    uri,
    client_headers,
    nil,
    Ingenico::Direct::SDK::Domain::PayoutResponse,
    context
  )
rescue ResponseException => e
  error_type = Ingenico::Direct::SDK::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end