openapi_client

OpenapiClient - the Ruby gem for the BVNK API Endpoints

The BVNK API is designed to facilitate seamless and secure transactions including payments, channels, and digital wallet transactions.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build openapi_client.gemspec

Then either install the gem locally:

gem install ./openapi_client-1.0.0.gem

(for development, run gem install --dev ./openapi_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'openapi_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'openapi_client'

# Setup authorization
OpenapiClient.configure do |config|
  # Configure API key authorization: Hawk
  config.api_key['Hawk'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Hawk'] = 'Bearer'
end

api_instance = OpenapiClient::ChannelsApi.new
opts = {
  merchant_channel_request_dto: OpenapiClient::MerchantChannelRequestDto.new({merchant_id: 'merchant_id_example', pay_currency: 'pay_currency_example', display_currency: 'display_currency_example', reference: 'reference_example'}) # MerchantChannelRequestDto | 
}

begin
  #Create Channel
  result = api_instance.channel_create(opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ChannelsApi->channel_create: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.sandbox.bvnk.com

Class	Method	HTTP request	Description
OpenapiClient::ChannelsApi	channel_create	POST /api/v2/channel	Create Channel
OpenapiClient::ChannelsApi	channel_list	GET /api/v2/channel	List Channels
OpenapiClient::ChannelsApi	channel_payment_list	GET /api/v2/channel/payment	List Channel Payments
OpenapiClient::ChannelsApi	channel_payment_read	GET /api/v2/channel/payment/{uuid}	Get Channel Payment
OpenapiClient::ChannelsApi	channel_read	GET /api/v2/channel/{uuid}	Get Channel
OpenapiClient::CurrenciesApi	list_currencies_crypto	GET /api/currency/crypto	List Crypto Currencies
OpenapiClient::CurrenciesApi	list_currencies_deposit	GET /api/currency/deposit	List Wallet Currencies
OpenapiClient::CurrenciesApi	list_currencies_fiat	GET /api/currency/fiat	List Fiat Currencies
OpenapiClient::MerchantIDsApi	merchant_id_create	POST /api/v1/merchant	Create Merchant ID
OpenapiClient::MerchantIDsApi	merchant_id_list	GET /api/v1/merchant	List Merchant IDs
OpenapiClient::PaymentsApi	payment_create	POST /api/v1/pay/summary	Create payment
OpenapiClient::PaymentsApi	payment_list	GET /api/v1/pay/summary	List Payments
OpenapiClient::PaymentsApi	payment_out_validate	PUT /api/v1/pay/validate	Validate Address
OpenapiClient::PaymentsApi	payment_read	GET /api/v1/pay/{uuid}/summary	Get Payment
OpenapiClient::TradingAndConversionsApi	quote_accept	PUT /api/v1/quote/accept/{uuid}	Accept Quote
OpenapiClient::TradingAndConversionsApi	quote_create	POST /api/v1/quote	Create Quote
OpenapiClient::TradingAndConversionsApi	quote_list	GET /api/v1/quote/{merchantId}	List Quotes
OpenapiClient::TradingAndConversionsApi	quote_read	GET /api/v1/quote/{uuid}	Get Quote
OpenapiClient::WalletsApi	wallet_balance_list	GET /api/wallet/balances	List Wallet Balances
OpenapiClient::WalletsApi	wallet_create	POST /api/wallet	Create Wallet
OpenapiClient::WalletsApi	wallet_list	GET /api/wallet	List Wallets
OpenapiClient::WalletsApi	wallet_read	GET /api/wallet/{id}	Get Wallet
OpenapiClient::WalletsApi	wallet_transaction_report	GET /api/transaction/report	Transactions Report

Documentation for Models

• OpenapiClient::AcceptedQuoteDto
• OpenapiClient::AccountMethodDto
• OpenapiClient::AlternativeAddressDto
• OpenapiClient::BalanceDto
• OpenapiClient::ClientValidationErrorDto
• OpenapiClient::CryptoAddressDto
• OpenapiClient::CurrencyDto
• OpenapiClient::CurrencyFiatDto
• OpenapiClient::CurrencyOptions
• OpenapiClient::CurrencyProtocol
• OpenapiClient::DirectionDto
• OpenapiClient::ExchangeRateDto
• OpenapiClient::ExternalCurrencyWithdrawalParameter
• OpenapiClient::FeeDto
• OpenapiClient::FeesDto
• OpenapiClient::FormDto
• OpenapiClient::GatewayTransactionDto
• OpenapiClient::MerchantChannelDto
• OpenapiClient::MerchantChannelPaymentDto
• OpenapiClient::MerchantChannelRequestDto
• OpenapiClient::MerchantDto
• OpenapiClient::MerchantIdCreateRequest
• OpenapiClient::MerchantIdCreateRequestWallet
• OpenapiClient::NetworkFeeDto
• OpenapiClient::PayAmountsDto
• OpenapiClient::PayInDetailDto
• OpenapiClient::PayInInstructionDto
• OpenapiClient::PayInMethodDto
• OpenapiClient::PayOutDetailDto
• OpenapiClient::PayOutInstructionDto
• OpenapiClient::PayOutMethodDto
• OpenapiClient::PayRequestDto
• OpenapiClient::PaymentLegDto
• OpenapiClient::PaymentStatusDto
• OpenapiClient::QuoteDto
• OpenapiClient::QuoteRequestDto
• OpenapiClient::ServerErrorDto
• OpenapiClient::SummaryPaymentDto
• OpenapiClient::TransactionReportDto
• OpenapiClient::TransactionReportRequestDataDto
• OpenapiClient::ValidationErrorDto
• OpenapiClient::WalletDto
• OpenapiClient::WalletRequestDto

Documentation for Authorization

Authentication schemes defined for the API:

Hawk

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header