Module: StraddlePay

Defined in:
lib/straddle_pay.rb,
lib/straddle_pay/client.rb,
lib/straddle_pay/config.rb,
lib/straddle_pay/engine.rb,
lib/straddle_pay/errors.rb,
lib/straddle_pay/version.rb,
lib/straddle_pay/webhook.rb,
lib/straddle_pay/resources/base.rb,
lib/straddle_pay/resources/embed.rb,
lib/straddle_pay/resources/bridge.rb,
lib/straddle_pay/resources/charges.rb,
lib/straddle_pay/resources/paykeys.rb,
lib/straddle_pay/resources/payouts.rb,
lib/straddle_pay/resources/reports.rb,
lib/straddle_pay/resources/payments.rb,
lib/straddle_pay/resources/customers.rb,
lib/straddle_pay/resources/bridge_links.rb,
lib/straddle_pay/resources/embed_accounts.rb,
lib/straddle_pay/resources/funding_events.rb,
lib/straddle_pay/resources/account_settings.rb,
lib/straddle_pay/resources/customer_reviews.rb,
lib/straddle_pay/resources/embed_organizations.rb,
lib/straddle_pay/resources/embed_representatives.rb,
lib/straddle_pay/resources/funding_event_payments.rb,
lib/straddle_pay/resources/embed_linked_bank_accounts.rb,
lib/straddle_pay/resources/account_capability_requests.rb

Overview

Ruby client for the Straddle payment infrastructure API.

Examples:

Global configuration

StraddlePay.configure do |config|
  config.api_key     = ENV.fetch("STRADDLE_API_KEY")
  config.environment = :production
end

Per-instance client

client = StraddlePay::Client.new(api_key: "sk_test_...")

See Also:

Defined Under Namespace

Modules: Resources, Webhook Classes: AuthenticationError, Client, ClientError, Config, Engine, Error, NetworkError, RateLimitError, ServerError, SignatureVerificationError

Constant Summary collapse

VERSION =

Returns current gem version.

Returns:

  • (String) —

    current gem version

"0.3.0"

Class Method Summary collapse

Class Method Details

.config ⇒ Config

Returns current configuration instance.

Returns:

  • (Config) —

    current configuration instance



53
54
55
 
# File 'lib/straddle_pay.rb', line 53

def config
  @config ||= Config.new
end

.configure {|config| ... } ⇒ Object

Yields the global configuration for modification.

Yield Parameters:

  • config (Config) —

    the configuration instance



60
61
62
 
# File 'lib/straddle_pay.rb', line 60

def configure
  yield(config)
end

.reset_configuration! ⇒ void

This method returns an undefined value.

Reset configuration to defaults.



66
67
68
 
# File 'lib/straddle_pay.rb', line 66

def reset_configuration!
  @config = nil
end