bvnk_api_endpoints

BvnkApiEndpoints - JavaScript client for 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.1
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install bvnk_api_endpoints --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your bvnk_api_endpoints from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var BvnkApiEndpoints = require('bvnk_api_endpoints');

var defaultClient = BvnkApiEndpoints.ApiClient.instance;
// Configure API key authorization: Hawk
var Hawk = defaultClient.authentications['Hawk'];
Hawk.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Hawk.apiKeyPrefix['Authorization'] = "Token"

var api = new BvnkApiEndpoints.ChannelsApi()
var opts = {
  'merchantChannelRequestDto': new BvnkApiEndpoints.MerchantChannelRequestDto() // {MerchantChannelRequestDto} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.channelCreate(opts, callback);

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
BvnkApiEndpoints.ChannelsApi	channelCreate	POST /api/v2/channel	Create Channel
BvnkApiEndpoints.ChannelsApi	channelList	GET /api/v2/channel	List Channels
BvnkApiEndpoints.ChannelsApi	channelPaymentList	GET /api/v2/channel/payment	List Channel Payments
BvnkApiEndpoints.ChannelsApi	channelPaymentRead	GET /api/v2/channel/payment/{uuid}	Get Channel Payment
BvnkApiEndpoints.ChannelsApi	channelRead	GET /api/v2/channel/{uuid}	Get Channel
BvnkApiEndpoints.CurrenciesApi	listCurrenciesCrypto	GET /api/currency/crypto	List Crypto Currencies
BvnkApiEndpoints.CurrenciesApi	listCurrenciesDeposit	GET /api/currency/deposit	List Wallet Currencies
BvnkApiEndpoints.CurrenciesApi	listCurrenciesFiat	GET /api/currency/fiat	List Fiat Currencies
BvnkApiEndpoints.MerchantIDsApi	merchantIdCreate	POST /api/v1/merchant	Create Merchant ID
BvnkApiEndpoints.MerchantIDsApi	merchantIdList	GET /api/v1/merchant	List Merchant IDs
BvnkApiEndpoints.PaymentsApi	paymentCreate	POST /api/v1/pay/summary	Create payment
BvnkApiEndpoints.PaymentsApi	paymentList	GET /api/v1/pay/summary	List Payments
BvnkApiEndpoints.PaymentsApi	paymentOutValidate	PUT /api/v1/pay/validate	Validate Address
BvnkApiEndpoints.PaymentsApi	paymentRead	GET /api/v1/pay/{uuid}/summary	Get Payment
BvnkApiEndpoints.TradingAndConversionsApi	quoteAccept	PUT /api/v1/quote/accept/{uuid}	Accept Quote
BvnkApiEndpoints.TradingAndConversionsApi	quoteCreate	POST /api/v1/quote	Create Quote
BvnkApiEndpoints.TradingAndConversionsApi	quoteList	GET /api/v1/quote/{merchantId}	List Quotes
BvnkApiEndpoints.TradingAndConversionsApi	quoteRead	GET /api/v1/quote/{uuid}	Get Quote
BvnkApiEndpoints.WalletsApi	walletBalanceList	GET /api/wallet/balances	List Wallet Balances
BvnkApiEndpoints.WalletsApi	walletCreate	POST /api/wallet	Create Wallet
BvnkApiEndpoints.WalletsApi	walletList	GET /api/wallet	List Wallets
BvnkApiEndpoints.WalletsApi	walletRead	GET /api/wallet/{id}	Get Wallet
BvnkApiEndpoints.WalletsApi	walletTransactionReport	GET /api/transaction/report	Transactions Report

Documentation for Models

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

Documentation for Authorization

Authentication schemes defined for the API:

Hawk

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