|
| 1 | +# Messente\Api\AccountBalanceApi |
| 2 | + |
| 3 | +All URIs are relative to https://api.messente.com/v1, except if the operation defines another base path. |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +| ------------- | ------------- | ------------- | |
| 7 | +| [**getAccountBalance()**](AccountBalanceApi.md#getAccountBalance) | **GET** /get_balance | Get account balance | |
| 8 | +| [**getAccountBalanceUsingPost()**](AccountBalanceApi.md#getAccountBalanceUsingPost) | **POST** /get_balance | Get account balance | |
| 9 | + |
| 10 | + |
| 11 | +## `getAccountBalance()` |
| 12 | + |
| 13 | +```php |
| 14 | +getAccountBalance($username, $password): string |
| 15 | +``` |
| 16 | +### URI(s): |
| 17 | +- https://api2.messente.com Override base path for account balance API |
| 18 | +Get account balance |
| 19 | + |
| 20 | +### Example |
| 21 | + |
| 22 | +```php |
| 23 | +<?php |
| 24 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 25 | + |
| 26 | + |
| 27 | +// Configure API key authorization: apiPassword |
| 28 | +$config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKey('password', 'YOUR_API_KEY'); |
| 29 | +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 30 | +// $config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('password', 'Bearer'); |
| 31 | + |
| 32 | +// Configure API key authorization: apiUsername |
| 33 | +$config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKey('username', 'YOUR_API_KEY'); |
| 34 | +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 35 | +// $config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('username', 'Bearer'); |
| 36 | + |
| 37 | + |
| 38 | +$apiInstance = new Messente\Api\Api\AccountBalanceApi( |
| 39 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 40 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 41 | + new GuzzleHttp\Client(), |
| 42 | + $config |
| 43 | +); |
| 44 | +$username = 'username_example'; // string | The API username |
| 45 | +$password = 'password_example'; // string | The API password |
| 46 | + |
| 47 | +$hostIndex = 0; |
| 48 | +$variables = [ |
| 49 | +]; |
| 50 | + |
| 51 | +try { |
| 52 | + $result = $apiInstance->getAccountBalance($username, $password, $hostIndex, $variables); |
| 53 | + print_r($result); |
| 54 | +} catch (Exception $e) { |
| 55 | + echo 'Exception when calling AccountBalanceApi->getAccountBalance: ', $e->getMessage(), PHP_EOL; |
| 56 | +} |
| 57 | +``` |
| 58 | + |
| 59 | +### Parameters |
| 60 | + |
| 61 | +| Name | Type | Description | Notes | |
| 62 | +| ------------- | ------------- | ------------- | ------------- | |
| 63 | +| **username** | **string**| The API username | | |
| 64 | +| **password** | **string**| The API password | | |
| 65 | +| hostIndex | null|int | Host index. Defaults to null. If null, then the library will use $this->hostIndex instead | [optional] | |
| 66 | +| variables | array | Associative array of variables to pass to the host. Defaults to empty array. | [optional] | |
| 67 | + |
| 68 | +### Return type |
| 69 | + |
| 70 | +**string** |
| 71 | + |
| 72 | +### Authorization |
| 73 | + |
| 74 | +[apiPassword](../../README.md#apiPassword), [apiUsername](../../README.md#apiUsername) |
| 75 | + |
| 76 | +### HTTP request headers |
| 77 | + |
| 78 | +- **Content-Type**: Not defined |
| 79 | +- **Accept**: `text/plain` |
| 80 | + |
| 81 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 82 | +[[Back to Model list]](../../README.md#models) |
| 83 | +[[Back to README]](../../README.md) |
| 84 | + |
| 85 | +## `getAccountBalanceUsingPost()` |
| 86 | + |
| 87 | +```php |
| 88 | +getAccountBalanceUsingPost($username, $password): string |
| 89 | +``` |
| 90 | +### URI(s): |
| 91 | +- https://api2.messente.com Override base path for account balance API |
| 92 | +Get account balance |
| 93 | + |
| 94 | +### Example |
| 95 | + |
| 96 | +```php |
| 97 | +<?php |
| 98 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 99 | + |
| 100 | + |
| 101 | +// Configure API key authorization: apiPassword |
| 102 | +$config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKey('password', 'YOUR_API_KEY'); |
| 103 | +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 104 | +// $config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('password', 'Bearer'); |
| 105 | + |
| 106 | +// Configure API key authorization: apiUsername |
| 107 | +$config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKey('username', 'YOUR_API_KEY'); |
| 108 | +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 109 | +// $config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('username', 'Bearer'); |
| 110 | + |
| 111 | + |
| 112 | +$apiInstance = new Messente\Api\Api\AccountBalanceApi( |
| 113 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 114 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 115 | + new GuzzleHttp\Client(), |
| 116 | + $config |
| 117 | +); |
| 118 | +$username = 'username_example'; // string | The API username |
| 119 | +$password = 'password_example'; // string | The API password |
| 120 | + |
| 121 | +$hostIndex = 0; |
| 122 | +$variables = [ |
| 123 | +]; |
| 124 | + |
| 125 | +try { |
| 126 | + $result = $apiInstance->getAccountBalanceUsingPost($username, $password, $hostIndex, $variables); |
| 127 | + print_r($result); |
| 128 | +} catch (Exception $e) { |
| 129 | + echo 'Exception when calling AccountBalanceApi->getAccountBalanceUsingPost: ', $e->getMessage(), PHP_EOL; |
| 130 | +} |
| 131 | +``` |
| 132 | + |
| 133 | +### Parameters |
| 134 | + |
| 135 | +| Name | Type | Description | Notes | |
| 136 | +| ------------- | ------------- | ------------- | ------------- | |
| 137 | +| **username** | **string**| The API username | | |
| 138 | +| **password** | **string**| The API password | | |
| 139 | +| hostIndex | null|int | Host index. Defaults to null. If null, then the library will use $this->hostIndex instead | [optional] | |
| 140 | +| variables | array | Associative array of variables to pass to the host. Defaults to empty array. | [optional] | |
| 141 | + |
| 142 | +### Return type |
| 143 | + |
| 144 | +**string** |
| 145 | + |
| 146 | +### Authorization |
| 147 | + |
| 148 | +[apiPassword](../../README.md#apiPassword), [apiUsername](../../README.md#apiUsername) |
| 149 | + |
| 150 | +### HTTP request headers |
| 151 | + |
| 152 | +- **Content-Type**: Not defined |
| 153 | +- **Accept**: `text/plain` |
| 154 | + |
| 155 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 156 | +[[Back to Model list]](../../README.md#models) |
| 157 | +[[Back to README]](../../README.md) |
0 commit comments