Module: TransferZero

Defined in:
lib/transferzero-sdk/version.rb,
lib/transferzero-sdk.rb,
lib/transferzero-sdk/api_error.rb,
lib/transferzero-sdk/api_client.rb,
lib/transferzero-sdk/api/logs_api.rb,
lib/transferzero-sdk/models/debit.rb,
lib/transferzero-sdk/configuration.rb,
lib/transferzero-sdk/models/sender.rb,
lib/transferzero-sdk/models/account.rb,
lib/transferzero-sdk/models/api_log.rb,
lib/transferzero-sdk/models/webhook.rb,
lib/transferzero-sdk/api/senders_api.rb,
lib/transferzero-sdk/models/currency.rb,
lib/transferzero-sdk/models/document.rb,
lib/transferzero-sdk/api/accounts_api.rb,
lib/transferzero-sdk/api/api_logs_api.rb,
lib/transferzero-sdk/api/webhooks_api.rb,
lib/transferzero-sdk/models/recipient.rb,
lib/transferzero-sdk/api/documents_api.rb,
lib/transferzero-sdk/models/pagination.rb,
lib/transferzero-sdk/api/recipients_api.rb,
lib/transferzero-sdk/models/transaction.rb,
lib/transferzero-sdk/models/webhook_log.rb,
lib/transferzero-sdk/models/account_meta.rb,
lib/transferzero-sdk/models/error_status.rb,
lib/transferzero-sdk/models/payin_method.rb,
lib/transferzero-sdk/models/sender_state.rb,
lib/transferzero-sdk/api/transactions_api.rb,
lib/transferzero-sdk/models/debit_request.rb,
lib/transferzero-sdk/models/payout_method.rb,
lib/transferzero-sdk/api/currency_info_api.rb,
lib/transferzero-sdk/models/debit_response.rb,
lib/transferzero-sdk/models/payment_method.rb,
lib/transferzero-sdk/models/sender_request.rb,
lib/transferzero-sdk/models/sender_webhook.rb,
lib/transferzero-sdk/api/account_debits_api.rb,
lib/transferzero-sdk/api/payout_methods_api.rb,
lib/transferzero-sdk/models/pagination_meta.rb,
lib/transferzero-sdk/models/recipient_state.rb,
lib/transferzero-sdk/models/sender_response.rb,
lib/transferzero-sdk/api/payment_methods_api.rb,
lib/transferzero-sdk/models/account_response.rb,
lib/transferzero-sdk/models/api_log_response.rb,
lib/transferzero-sdk/models/document_request.rb,
lib/transferzero-sdk/models/document_webhook.rb,
lib/transferzero-sdk/models/field_validation.rb,
lib/transferzero-sdk/models/currency_exchange.rb,
lib/transferzero-sdk/models/currency_opposite.rb,
lib/transferzero-sdk/models/document_response.rb,
lib/transferzero-sdk/models/field_description.rb,
lib/transferzero-sdk/models/recipient_request.rb,
lib/transferzero-sdk/models/recipient_webhook.rb,
lib/transferzero-sdk/models/transaction_state.rb,
lib/transferzero-sdk/models/debit_list_request.rb,
lib/transferzero-sdk/models/recipient_response.rb,
lib/transferzero-sdk/models/transaction_traits.rb,
lib/transferzero-sdk/models/webhook_definition.rb,
lib/transferzero-sdk/api/account_validation_api.rb,
lib/transferzero-sdk/models/debit_list_response.rb,
lib/transferzero-sdk/models/transaction_request.rb,
lib/transferzero-sdk/models/transaction_webhook.rb,
lib/transferzero-sdk/models/payin_method_details.rb,
lib/transferzero-sdk/models/payin_method_request.rb,
lib/transferzero-sdk/models/sender_list_response.rb,
lib/transferzero-sdk/models/sender_response_meta.rb,
lib/transferzero-sdk/models/transaction_response.rb,
lib/transferzero-sdk/models/webhook_log_metadata.rb,
lib/transferzero-sdk/models/webhook_log_response.rb,
lib/transferzero-sdk/models/account_list_response.rb,
lib/transferzero-sdk/models/api_log_list_response.rb,
lib/transferzero-sdk/models/debit_request_wrapper.rb,
lib/transferzero-sdk/models/payout_method_details.rb,
lib/transferzero-sdk/models/payout_method_request.rb,
lib/transferzero-sdk/models/payout_method_webhook.rb,
lib/transferzero-sdk/models/sender_webhook_all_of.rb,
lib/transferzero-sdk/models/currency_list_response.rb,
lib/transferzero-sdk/models/document_list_response.rb,
lib/transferzero-sdk/models/payout_method_response.rb,
lib/transferzero-sdk/models/document_webhook_all_of.rb,
lib/transferzero-sdk/models/field_select_validation.rb,
lib/transferzero-sdk/models/payment_method_opposite.rb,
lib/transferzero-sdk/models/recipient_list_response.rb,
lib/transferzero-sdk/models/account_validation_error.rb,
lib/transferzero-sdk/models/currency_exchange_all_of.rb,
lib/transferzero-sdk/models/currency_opposite_all_of.rb,
lib/transferzero-sdk/models/recipient_webhook_all_of.rb,
lib/transferzero-sdk/models/sender_response_existing.rb,
lib/transferzero-sdk/models/account_validation_result.rb,
lib/transferzero-sdk/models/payout_method_gender_enum.rb,
lib/transferzero-sdk/models/transaction_list_response.rb,
lib/transferzero-sdk/models/transaction_response_meta.rb,
lib/transferzero-sdk/models/webhook_log_list_response.rb,
lib/transferzero-sdk/models/account_validation_request.rb,
lib/transferzero-sdk/models/payout_method_details_iban.rb,
lib/transferzero-sdk/models/transaction_webhook_all_of.rb,
lib/transferzero-sdk/models/webhook_definition_request.rb,
lib/transferzero-sdk/models/account_validation_response.rb,
lib/transferzero-sdk/models/payin_method_details_mobile.rb,
lib/transferzero-sdk/models/payout_method_list_response.rb,
lib/transferzero-sdk/models/webhook_definition_response.rb,
lib/transferzero-sdk/models/payment_method_list_response.rb,
lib/transferzero-sdk/models/payout_method_details_mobile.rb,
lib/transferzero-sdk/models/payout_method_webhook_all_of.rb,
lib/transferzero-sdk/models/validation_error_description.rb,
lib/transferzero-sdk/models/webhook_log_metadata_request.rb,
lib/transferzero-sdk/models/payin_method_details_ngn_bank.rb,
lib/transferzero-sdk/models/payout_method_details_balance.rb,
lib/transferzero-sdk/models/transaction_response_existing.rb,
lib/transferzero-sdk/models/webhook_log_metadata_response.rb,
lib/transferzero-sdk/models/payout_method_details_ghs_bank.rb,
lib/transferzero-sdk/models/payout_method_details_mad_cash.rb,
lib/transferzero-sdk/models/payout_method_details_ngn_bank.rb,
lib/transferzero-sdk/models/payout_method_details_xof_bank.rb,
lib/transferzero-sdk/models/currency_exchange_list_response.rb,
lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb,
lib/transferzero-sdk/models/webhook_definition_list_response.rb,
lib/transferzero-sdk/models/payout_method_mobile_provider_enum.rb,
lib/transferzero-sdk/models/payout_method_bank_account_type_enum.rb,
lib/transferzero-sdk/models/payout_method_identity_card_type_enum.rb,
lib/transferzero-sdk/models/webhook_definition_event_list_response.rb

Overview

#TransferZero API

#Reference documentation for the TransferZero API V1

OpenAPI spec version: 1.0

Generated by: openapi-generator.tech OpenAPI Generator version: 4.0.0-beta3

Defined Under Namespace

Classes: APILogsApi, Account, AccountDebitsApi, AccountListResponse, AccountMeta, AccountResponse, AccountValidationApi, AccountValidationError, AccountValidationRequest, AccountValidationResponse, AccountValidationResult, AccountsApi, ApiClient, ApiError, ApiLog, ApiLogListResponse, ApiLogResponse, Configuration, Currency, CurrencyExchange, CurrencyExchangeAllOf, CurrencyExchangeListResponse, CurrencyInfoApi, CurrencyListResponse, CurrencyOpposite, CurrencyOppositeAllOf, Debit, DebitListRequest, DebitListResponse, DebitRequest, DebitRequestWrapper, DebitResponse, Document, DocumentListResponse, DocumentRequest, DocumentResponse, DocumentWebhook, DocumentWebhookAllOf, DocumentsApi, ErrorStatus, FieldDescription, FieldSelectValidation, FieldValidation, LogsApi, Pagination, PaginationMeta, PayinMethod, PayinMethodDetails, PayinMethodDetailsMobile, PayinMethodDetailsNGNBank, PayinMethodRequest, PaymentMethod, PaymentMethodListResponse, PaymentMethodOpposite, PaymentMethodsApi, PayoutMethod, PayoutMethodBankAccountTypeEnum, PayoutMethodDetails, PayoutMethodDetailsBalance, PayoutMethodDetailsGHSBank, PayoutMethodDetailsIBAN, PayoutMethodDetailsMADCash, PayoutMethodDetailsMobile, PayoutMethodDetailsNGNBank, PayoutMethodDetailsXOFBank, PayoutMethodDetailsXOFMobile, PayoutMethodGenderEnum, PayoutMethodIdentityCardTypeEnum, PayoutMethodListResponse, PayoutMethodMobileProviderEnum, PayoutMethodRequest, PayoutMethodResponse, PayoutMethodWebhook, PayoutMethodWebhookAllOf, PayoutMethodsApi, Recipient, RecipientListResponse, RecipientRequest, RecipientResponse, RecipientState, RecipientWebhook, RecipientWebhookAllOf, RecipientsApi, Sender, SenderListResponse, SenderRequest, SenderResponse, SenderResponseExisting, SenderResponseMeta, SenderState, SenderWebhook, SenderWebhookAllOf, SendersApi, Transaction, TransactionListResponse, TransactionRequest, TransactionResponse, TransactionResponseExisting, TransactionResponseMeta, TransactionState, TransactionTraits, TransactionWebhook, TransactionWebhookAllOf, TransactionsApi, ValidationErrorDescription, Webhook, WebhookDefinition, WebhookDefinitionEventListResponse, WebhookDefinitionListResponse, WebhookDefinitionRequest, WebhookDefinitionResponse, WebhookLog, WebhookLogListResponse, WebhookLogMetadata, WebhookLogMetadataRequest, WebhookLogMetadataResponse, WebhookLogResponse, WebhooksApi

Constant Summary collapse

VERSION =
'1.3.0'

Class Method Summary collapse

Class Method Details

.configureObject

Customize default settings for the SDK using block.

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

If no block given, return the default Configuration object.


139
140
141
142
143
144
145
# File 'lib/transferzero-sdk.rb', line 139

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