Skip to content

FundsApi.md

Latest commit

 

History

History
67 lines (43 loc) · 1.8 KB

FundsApi.md

File metadata and controls

67 lines (43 loc) · 1.8 KB

GoAdServerApi\FundsApi

Account balance and deposit status.

All URIs are relative to https://up.go-adserver.com, except if the operation defines another base path.

Method HTTP request Description
apiV1FundsGet() GET /api/v1/funds Current advertiser balance + pending deposits.

apiV1FundsGet()

apiV1FundsGet(): \GoAdServerApi\Model\ApiV1FundsGet200Response

Current advertiser balance + pending deposits.

Use this before deciding to launch or pause a campaign — low_balance is true when current balance is below the user-configured minimum.

Example

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


// Configure Bearer (gas_live_<32 chars>) authorization: apiKey
$config = GoAdServerApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new GoAdServerApi\Api\FundsApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\GoAdServerApi\Model\ApiV1FundsGet200Response

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]