openapi-java-client

BVNK API Endpoints

• API version: 1.0.1
  • Build date: 2023-07-05T21:04:47.186508+02:00[Africa/Johannesburg]

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

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-java-client</artifactId>
  <version>1.0.1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'openapi-java-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'openapi-java-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "org.openapitools:openapi-java-client:1.0.1"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/openapi-java-client-1.0.1.jar
• target/lib/*.jar

Getting Started

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

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ChannelsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sandbox.bvnk.com");
    
    // Configure API key authorization: Hawk
    ApiKeyAuth Hawk = (ApiKeyAuth) defaultClient.getAuthentication("Hawk");
    Hawk.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Hawk.setApiKeyPrefix("Token");

    ChannelsApi apiInstance = new ChannelsApi(defaultClient);
    String merchantId = "c02153ae-8ac8-4222-80e8-b2b2af85bd78"; // String | The merchant ID that the channels belong to
    String offset = "0"; // String | Offset
    String max = "10"; // String | Maximum number of items in response
    PaymentStatusDto sort = PaymentStatusDto.fromValue("PENDING"); // PaymentStatusDto | The attribute used to sort the data
    String order = "asc"; // String | Ordering direction
    try {
      List<MerchantChannel> result = apiInstance.apiV2ChannelGet(merchantId, offset, max, sort, order);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ChannelsApi#apiV2ChannelGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ChannelsApi	apiV2ChannelGet	GET /api/v2/channel	List Channels
ChannelsApi	apiV2ChannelPaymentGet	GET /api/v2/channel/payment	List Channel Payments
ChannelsApi	apiV2ChannelPaymentUuidGet	GET /api/v2/channel/payment/{uuid}	Get Channel Payment
ChannelsApi	apiV2ChannelPost	POST /api/v2/channel	Create Channel
ChannelsApi	apiV2ChannelUuidGet	GET /api/v2/channel/{uuid}	Get Channel
CurrenciesApi	listCurrenciesCrypto	GET /api/currency/crypto	List Crypto Currencies
CurrenciesApi	listCurrenciesDeposit	GET /api/currency/deposit	List Wallet Currencies
CurrenciesApi	listCurrenciesFiat	GET /api/currency/fiat	List Fiat Currencies
MerchantIdsApi	merchantIdCreate	POST /api/v1/merchant	Create Merchant ID
MerchantIdsApi	merchantIdList	GET /api/v1/merchant	List Merchant IDs
PaymentsApi	apiV1PaySummaryGet	GET /api/v1/pay/summary	List Payments
PaymentsApi	apiV1PaySummaryPost	POST /api/v1/pay/summary	Create payment
PaymentsApi	apiV1PayUuidSummaryGet	GET /api/v1/pay/{uuid}/summary	Get Payment
PaymentsApi	apiV1PayValidatePut	PUT /api/v1/pay/validate	Validate Address
TradingAndConversionsApi	quoteAccept	PUT /api/v1/quote/accept/{uuid}	Accept Quote
TradingAndConversionsApi	quoteCreate	POST /api/v1/quote	Create Quote
TradingAndConversionsApi	quoteList	GET /api/v1/quote/{merchantId}	List Quotes
TradingAndConversionsApi	quoteRead	GET /api/v1/quote/{uuid}	Read Quote
WalletsApi	transactionReport	GET /api/transaction/report	Transactions Report
WalletsApi	walletBalanceList	GET /api/wallet/balances	List Wallet Balances
WalletsApi	walletCreate	POST /api/wallet	Create Wallet
WalletsApi	walletList	GET /api/wallet	List Wallets
WalletsApi	walletRGet	GET /api/wallet/{id}	Get Wallet

Documentation for Models

• AcceptedQuote
• AccountMethod
• AlternativeAddress
• Balance
• ClientValidationErrorDto
• CryptoAddressDto
• Currency
• CurrencyFiat
• CurrencyOptions
• CurrencyProtocol
• DirectionDto
• ExchangeRateDto
• ExternalCurrencyWithdrawalParameter
• Fee
• Fees
• Form
• GatewayTransactionDto
• Merchant
• MerchantChannel
• MerchantChannelPayment
• MerchantChannelRequest
• MerchantIdCreateRequest
• MerchantIdCreateRequestWallet
• NetworkFee
• PayAmountsDto
• PayInDetailDto
• PayInInstruction
• PayInMethod
• PayOutDetailDto
• PayOutInstruction
• PayOutMethod
• PayRequestDto
• PaymentLeg
• PaymentStatusDto
• Quote
• QuoteRequest
• ServerErrorDto
• SummaryPaymentDto
• TransactionReport
• TransactionReportRequestData
• ValidationErrorDto
• Wallet
• WalletRequest

Documentation for Authorization

Authentication schemes defined for the API:

Hawk

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author