Module: OrbipayPaymentsapiClient

Defined in:
lib/orbipay_paymentsapi_client/version.rb,
lib/orbipay_paymentsapi_client.rb,
lib/orbipay_paymentsapi_client/multimap.rb,
lib/orbipay_paymentsapi_client/api_error.rb,
lib/orbipay_paymentsapi_client/api_client.rb,
lib/orbipay_paymentsapi_client/common_util.rb,
lib/orbipay_paymentsapi_client/wrappers/fee.rb,
lib/orbipay_paymentsapi_client/configuration.rb,
lib/orbipay_paymentsapi_client/wrappers/base.rb,
lib/orbipay_paymentsapi_client/api/refund_api.rb,
lib/orbipay_paymentsapi_client/wrappers/error.rb,
lib/orbipay_paymentsapi_client/api/payment_api.rb,
lib/orbipay_paymentsapi_client/models/error_vo.rb,
lib/orbipay_paymentsapi_client/wrappers/refund.rb,
lib/orbipay_paymentsapi_client/api/customer_api.rb,
lib/orbipay_paymentsapi_client/wrappers/address.rb,
lib/orbipay_paymentsapi_client/wrappers/payment.rb,
lib/orbipay_paymentsapi_client/wrappers/refunds.rb,
lib/orbipay_paymentsapi_client/models/address_vo.rb,
lib/orbipay_paymentsapi_client/orbipay_api_error.rb,
lib/orbipay_paymentsapi_client/wrappers/customer.rb,
lib/orbipay_paymentsapi_client/wrappers/payments.rb,
lib/orbipay_paymentsapi_client/models/fee_request.rb,
lib/orbipay_paymentsapi_client/wrappers/customers.rb,
lib/orbipay_paymentsapi_client/models/fee_response.rb,
lib/orbipay_paymentsapi_client/wrappers/audit_info.rb,
lib/orbipay_paymentsapi_client/wrappers/fee_refund.rb,
lib/orbipay_paymentsapi_client/models/audit_info_vo.rb,
lib/orbipay_paymentsapi_client/wrappers/fee_payment.rb,
lib/orbipay_paymentsapi_client/api/payment_setup_api.rb,
lib/orbipay_paymentsapi_client/models/source_payment.rb,
lib/orbipay_paymentsapi_client/models/delete_response.rb,
lib/orbipay_paymentsapi_client/models/refund_response.rb,
lib/orbipay_paymentsapi_client/wrappers/payment_setup.rb,
lib/orbipay_paymentsapi_client/api/funding_account_api.rb,
lib/orbipay_paymentsapi_client/models/payment_response.rb,
lib/orbipay_paymentsapi_client/models/refunds_response.rb,
lib/orbipay_paymentsapi_client/wrappers/error_response.rb,
lib/orbipay_paymentsapi_client/wrappers/payment_setups.rb,
lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb,
lib/orbipay_paymentsapi_client/wrappers/simple_payment.rb,
lib/orbipay_paymentsapi_client/wrappers/source_payment.rb,
lib/orbipay_paymentsapi_client/api/customer_account_api.rb,
lib/orbipay_paymentsapi_client/models/customer_response.rb,
lib/orbipay_paymentsapi_client/models/error_response_vo.rb,
lib/orbipay_paymentsapi_client/models/payments_response.rb,
lib/orbipay_paymentsapi_client/models/resource_audit_vo.rb,
lib/orbipay_paymentsapi_client/wrappers/funding_account.rb,
lib/orbipay_paymentsapi_client/models/customers_response.rb,
lib/orbipay_paymentsapi_client/models/fee_refund_request.rb,
lib/orbipay_paymentsapi_client/wrappers/customer_account.rb,
lib/orbipay_paymentsapi_client/wrappers/funding_accounts.rb,
lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb,
lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb,
lib/orbipay_paymentsapi_client/models/fee_refund_response.rb,
lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb,
lib/orbipay_paymentsapi_client/wrappers/customer_accounts.rb,
lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb,
lib/orbipay_paymentsapi_client/handlers/get_refund_handler.rb,
lib/orbipay_paymentsapi_client/wrappers/invocation_context.rb,
lib/orbipay_paymentsapi_client/handlers/get_payment_handler.rb,
lib/orbipay_paymentsapi_client/models/create_refund_request.rb,
lib/orbipay_paymentsapi_client/models/payment_response_cgen.rb,
lib/orbipay_paymentsapi_client/handlers/get_customer_handler.rb,
lib/orbipay_paymentsapi_client/models/create_payment_request.rb,
lib/orbipay_paymentsapi_client/models/delete_payment_request.rb,
lib/orbipay_paymentsapi_client/models/payment_setup_response.rb,
lib/orbipay_paymentsapi_client/models/record_payment_request.rb,
lib/orbipay_paymentsapi_client/models/simple_payment_request.rb,
lib/orbipay_paymentsapi_client/models/update_payment_request.rb,
lib/orbipay_paymentsapi_client/handlers/create_refund_handler.rb,
lib/orbipay_paymentsapi_client/models/create_customer_request.rb,
lib/orbipay_paymentsapi_client/models/funding_account_address.rb,
lib/orbipay_paymentsapi_client/models/payment_setups_response.rb,
lib/orbipay_paymentsapi_client/models/simple_payment_response.rb,
lib/orbipay_paymentsapi_client/models/source_payment_customer.rb,
lib/orbipay_paymentsapi_client/models/update_customer_request.rb,
lib/orbipay_paymentsapi_client/handlers/create_payment_handler.rb,
lib/orbipay_paymentsapi_client/handlers/delete_payment_handler.rb,
lib/orbipay_paymentsapi_client/handlers/record_payment_handler.rb,
lib/orbipay_paymentsapi_client/handlers/simple_payment_handler.rb,
lib/orbipay_paymentsapi_client/handlers/update_payment_handler.rb,
lib/orbipay_paymentsapi_client/models/customer_minimal_request.rb,
lib/orbipay_paymentsapi_client/models/funding_account_response.rb,
lib/orbipay_paymentsapi_client/handlers/create_customer_handler.rb,
lib/orbipay_paymentsapi_client/handlers/update_customer_handler.rb,
lib/orbipay_paymentsapi_client/models/customer_account_response.rb,
lib/orbipay_paymentsapi_client/models/funding_accounts_response.rb,
lib/orbipay_paymentsapi_client/models/recorded_payment_response.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_refunds_handler.rb,
lib/orbipay_paymentsapi_client/models/customer_accounts_response.rb,
lib/orbipay_paymentsapi_client/models/customer_snapshot_response.rb,
lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb,
lib/orbipay_paymentsapi_client/wrappers/payment_network_response.rb,
lib/orbipay_paymentsapi_client/handlers/get_payment_setup_handler.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_payments_handler.rb,
lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb,
lib/orbipay_paymentsapi_client/models/customers_payments_response.rb,
lib/orbipay_paymentsapi_client/models/payment_network_response_vo.rb,
lib/orbipay_paymentsapi_client/models/payment_setup_response_cgen.rb,
lib/orbipay_paymentsapi_client/handlers/get_record_payment_handler.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_customers_handler.rb,
lib/orbipay_paymentsapi_client/models/create_payment_setup_request.rb,
lib/orbipay_paymentsapi_client/models/delete_payment_setup_request.rb,
lib/orbipay_paymentsapi_client/models/update_payment_setup_request.rb,
lib/orbipay_paymentsapi_client/handlers/add_funding_account_handler.rb,
lib/orbipay_paymentsapi_client/handlers/get_funding_account_handler.rb,
lib/orbipay_paymentsapi_client/models/funding_account_response_cgen.rb,
lib/orbipay_paymentsapi_client/models/get_recorded_payment_response.rb,
lib/orbipay_paymentsapi_client/handlers/delete_payment_setup_handler.rb,
lib/orbipay_paymentsapi_client/handlers/get_customer_account_handler.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_fee_payment_handler.rb,
lib/orbipay_paymentsapi_client/handlers/update_payment_setup_handler.rb,
lib/orbipay_paymentsapi_client/models/delete_funding_account_request.rb,
lib/orbipay_paymentsapi_client/models/renew_customer_account_request.rb,
lib/orbipay_paymentsapi_client/models/update_funding_account_request.rb,
lib/orbipay_paymentsapi_client/handlers/delete_record_payment_handler.rb,
lib/orbipay_paymentsapi_client/models/create_customer_account_request.rb,
lib/orbipay_paymentsapi_client/models/delete_recorded_payment_request.rb,
lib/orbipay_paymentsapi_client/models/funding_account_minimal_request.rb,
lib/orbipay_paymentsapi_client/models/replace_funding_account_request.rb,
lib/orbipay_paymentsapi_client/models/simple_payment_customer_request.rb,
lib/orbipay_paymentsapi_client/models/source_payment_customer_account.rb,
lib/orbipay_paymentsapi_client/models/update_customer_account_request.rb,
lib/orbipay_paymentsapi_client/handlers/delete_funding_account_handler.rb,
lib/orbipay_paymentsapi_client/handlers/renew_customer_account_handler.rb,
lib/orbipay_paymentsapi_client/handlers/update_funding_account_handler.rb,
lib/orbipay_paymentsapi_client/models/customer_account_minimal_request.rb,
lib/orbipay_paymentsapi_client/models/payment_schedule_minimal_request.rb,
lib/orbipay_paymentsapi_client/models/recorded_payment_funding_account.rb,
lib/orbipay_paymentsapi_client/models/simple_payment_customer_response.rb,
lib/orbipay_paymentsapi_client/handlers/replace_funding_account_handler.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_customers_page_handler.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_payment_setups_handler.rb,
lib/orbipay_paymentsapi_client/models/customers_payment_setups_response.rb,
lib/orbipay_paymentsapi_client/models/funding_account_snapshot_response.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_record_payments_handler.rb,
lib/orbipay_paymentsapi_client/models/customer_account_snapshot_response.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_funding_accounts_handler.rb,
lib/orbipay_paymentsapi_client/models/customers_funding_accounts_response.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_customer_accounts_handler.rb,
lib/orbipay_paymentsapi_client/models/customers_customer_accounts_response.rb,
lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb,
lib/orbipay_paymentsapi_client/handlers/create_recurring_payment_setup_handler.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_funding_accounts_page_handler.rb,
lib/orbipay_paymentsapi_client/handlers/retrieve_customer_accounts_page_handler.rb,
lib/orbipay_paymentsapi_client/models/update_payment_funding_account_minimal_request.rb

Overview

#Electronic Bill Presentment and Payments API

# The Electronic Bill Presentment and Payments (EBPP) API enables businesses to accept bank account, credit and debit card payment

Contact: support@billerpayments.com

Defined Under Namespace

Modules: ApiClient, CommonUtil, Configuration, OrbipayPaymentsapiClientApis, OrbipayPaymentsapiClientHandlers, OrbipayPaymentsapiClientModels Classes: Address, ApiError, AuditInfo, Base, Class, Customer, CustomerAccount, CustomerAccounts, Customers, Error, ErrorResponse, Fee, FeePayment, FeeRefund, FundingAccount, FundingAccounts, InvocationContext, Multimap, OrbipayApiError, Payment, PaymentNetworkResponse, PaymentSchedule, PaymentSetup, PaymentSetups, Payments, RecordedPayment, RecordedPayments, Refund, Refunds, ResourceAudit, SimplePayment, SourcePayment

Constant Summary collapse

LEVEL_DEBUG = 
Logger::DEBUG
LEVEL_ERROR = 
Logger::ERROR
LEVEL_INFO = 
Logger::INFO
VERSION = 
'1.11.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

OrbipayPaymentsapiClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



184
185
186
187
188
189
190
 
# File 'lib/orbipay_paymentsapi_client.rb', line 184

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end

.log_level ⇒ Object 



199
200
201
 
# File 'lib/orbipay_paymentsapi_client.rb', line 199

def self.log_level
  @log_level
end

.log_level=(value) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/orbipay_paymentsapi_client.rb', line 204

def self.log_level=(value)
  if value == "debug"
    value = LEVEL_DEBUG
  elsif value == "info"
    value = LEVEL_INFO
  end

  if !value.nil? && ![LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO].include?(value)
    raise ArgumentError,
          "log_level should only be set to `nil`, `debug` or `info`"
  end
  @log_level = value
end

.logger ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/orbipay_paymentsapi_client.rb', line 219

def self.logger
  if @logger.nil?
   @logger = Logger.new(STDOUT)
   unless log_level.nil?
    @logger.level = log_level
   else
    @logger.level = Logger::INFO
   end
  end
  @logger
end

.logger=(val) ⇒ Object 



232
233
234
 
# File 'lib/orbipay_paymentsapi_client.rb', line 232

def self.logger=(val)
  @logger = val
end