OpenAPIClient-php

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

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: Hawk
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ChannelsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$merchant_channel_request_dto = new \OpenAPI\Client\Model\MerchantChannelRequestDto(); // \OpenAPI\Client\Model\MerchantChannelRequestDto

try {
    $result = $apiInstance->channelCreate($merchant_channel_request_dto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->channelCreate: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Class	Method	HTTP request	Description
ChannelsApi	channelCreate	POST /api/v2/channel	Create Channel
ChannelsApi	channelList	GET /api/v2/channel	List Channels
ChannelsApi	channelPaymentList	GET /api/v2/channel/payment	List Channel Payments
ChannelsApi	channelPaymentRead	GET /api/v2/channel/payment/{uuid}	Get Channel Payment
ChannelsApi	channelRead	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	paymentCreate	POST /api/v1/pay/summary	Create payment
PaymentsApi	paymentList	GET /api/v1/pay/summary	List Payments
PaymentsApi	paymentOutValidate	PUT /api/v1/pay/validate	Validate Address
PaymentsApi	paymentRead	GET /api/v1/pay/{uuid}/summary	Get Payment
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}	Get Quote
WalletsApi	walletBalanceList	GET /api/wallet/balances	List Wallet Balances
WalletsApi	walletCreate	POST /api/wallet	Create Wallet
WalletsApi	walletList	GET /api/wallet	List Wallets
WalletsApi	walletRead	GET /api/wallet/{id}	Get Wallet
WalletsApi	walletTransactionReport	GET /api/transaction/report	Transactions Report

Models

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

Authorization

Authentication schemes defined for the API:

Hawk

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

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.1
• Build package: org.openapitools.codegen.languages.PhpClientCodegen