TXN Feed API

Avg Endpoints

getAvgField

This endpoint calculates the average value of a specific field (for example the amount).
/transactions/aggregate/avg/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/avg/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getAvgField(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getAvgField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getAvgField(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getAvgField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the average value of a specific field (for example the amount).
[apiInstance getAvgFieldWith:field
    requestConfig:requestConfig
              completionHandler: ^(AggregateAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvgField(field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getAvgFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the average value of a specific field (for example the amount).
                AggregateAvgResult result = apiInstance.getAvgField(field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getAvgField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getAvgField($field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getAvgField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getAvgField(field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getAvgField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the average value of a specific field (for example the amount).
    api_response = api_instance.get_avg_field(field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getAvgField: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = AvgApi::Context::default();
    let result = client.getAvgField(field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getAvgFieldForPayouts

This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
/transactions/aggregate/avg/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/avg/payouts/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getAvgFieldForPayouts(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getAvgFieldForPayouts(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
[apiInstance getAvgFieldForPayoutsWith:field
    requestConfig:requestConfig
              completionHandler: ^(AggregateAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvgFieldForPayouts(field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getAvgFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
                AggregateAvgResult result = apiInstance.getAvgFieldForPayouts(field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getAvgFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getAvgFieldForPayouts($field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getAvgFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getAvgFieldForPayouts(field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getAvgFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
    api_response = api_instance.get_avg_field_for_payouts(field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getAvgFieldForPayouts: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = AvgApi::Context::default();
    let result = client.getAvgFieldForPayouts(field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getAvgFieldForRefsAndRevs

This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
/transactions/aggregate/avg/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/avg/refundsandreversals/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getAvgFieldForRefsAndRevs(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getAvgFieldForRefsAndRevs(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
[apiInstance getAvgFieldForRefsAndRevsWith:field
    requestConfig:requestConfig
              completionHandler: ^(AggregateAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvgFieldForRefsAndRevs(field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getAvgFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
                AggregateAvgResult result = apiInstance.getAvgFieldForRefsAndRevs(field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getAvgFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getAvgFieldForRefsAndRevs($field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getAvgFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getAvgFieldForRefsAndRevs(field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getAvgFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
    api_response = api_instance.get_avg_field_for_refs_and_revs(field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getAvgFieldForRefsAndRevs: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = AvgApi::Context::default();
    let result = client.getAvgFieldForRefsAndRevs(field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getGrAvgField

This endpoint calculates the average value of a specific field (for example the amount) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/avg/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/avg/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getGrAvgField(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getGrAvgField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getGrAvgField(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getGrAvgField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (for example the amount) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGrAvgFieldWith:field
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrAvgField(field, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrAvgFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (for example the amount) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                AggregateGroupedAvgResult result = apiInstance.getGrAvgField(field, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getGrAvgField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getGrAvgField($field, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getGrAvgField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getGrAvgField(field => $field, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getGrAvgField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (for example the amount) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_gr_avg_field(field, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getGrAvgField: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = AvgApi::Context::default();
    let result = client.getGrAvgField(field, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getGrAvgFieldForPayouts

This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC')
/transactions/aggregate/group/avg/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/avg/payouts/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getGrAvgFieldForPayouts(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getGrAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getGrAvgFieldForPayouts(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getGrAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC')
[apiInstance getGrAvgFieldForPayoutsWith:field
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrAvgFieldForPayouts(field, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrAvgFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC')
                AggregateGroupedAvgResult result = apiInstance.getGrAvgFieldForPayouts(field, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getGrAvgFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getGrAvgFieldForPayouts($field, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getGrAvgFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getGrAvgFieldForPayouts(field => $field, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getGrAvgFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC')
    api_response = api_instance.get_gr_avg_field_for_payouts(field, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getGrAvgFieldForPayouts: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = AvgApi::Context::default();
    let result = client.getGrAvgFieldForPayouts(field, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getGrAvgFieldForRefsAndRevs

This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/avg/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/avg/refundsandreversals/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getGrAvgFieldForRefsAndRevs(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getGrAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getGrAvgFieldForRefsAndRevs(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getGrAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGrAvgFieldForRefsAndRevsWith:field
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrAvgFieldForRefsAndRevs(field, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrAvgFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                AggregateGroupedAvgResult result = apiInstance.getGrAvgFieldForRefsAndRevs(field, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getGrAvgFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getGrAvgFieldForRefsAndRevs($field, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getGrAvgFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getGrAvgFieldForRefsAndRevs(field => $field, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getGrAvgFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_gr_avg_field_for_refs_and_revs(field, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getGrAvgFieldForRefsAndRevs: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = AvgApi::Context::default();
    let result = client.getGrAvgFieldForRefsAndRevs(field, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getMrchtAvgFieldForAdmin

This endpoint calculates the average value of a specific field (for example the amount). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/avg/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/avg/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getMrchtAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtAvgFieldForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getMrchtAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtAvgFieldForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the average value of a specific field (for example the amount). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtAvgFieldForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtAvgFieldForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the average value of a specific field (for example the amount). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateAvgResult result = apiInstance.getMrchtAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getMrchtAvgFieldForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtAvgFieldForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getMrchtAvgFieldForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtAvgFieldForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getMrchtAvgFieldForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the average value of a specific field (for example the amount). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_avg_field_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getMrchtAvgFieldForAdmin: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = AvgApi::Context::default();
    let result = client.getMrchtAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtAvgFieldForPayoutsForAdmin

This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/avg/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/avg/payouts/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getMrchtAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtAvgFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getMrchtAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtAvgFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtAvgFieldForPayoutsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtAvgFieldForPayoutsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateAvgResult result = apiInstance.getMrchtAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getMrchtAvgFieldForPayoutsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtAvgFieldForPayoutsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getMrchtAvgFieldForPayoutsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtAvgFieldForPayoutsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getMrchtAvgFieldForPayoutsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_avg_field_for_payouts_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getMrchtAvgFieldForPayoutsForAdmin: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = AvgApi::Context::default();
    let result = client.getMrchtAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtAvgFieldForRefsAndRevsForAdmin

This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/avg/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/avg/refundsandreversals/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getMrchtAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtAvgFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getMrchtAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtAvgFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtAvgFieldForRefsAndRevsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtAvgFieldForRefsAndRevsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateAvgResult result = apiInstance.getMrchtAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getMrchtAvgFieldForRefsAndRevsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtAvgFieldForRefsAndRevsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getMrchtAvgFieldForRefsAndRevsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtAvgFieldForRefsAndRevsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getMrchtAvgFieldForRefsAndRevsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_avg_field_for_refs_and_revs_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getMrchtAvgFieldForRefsAndRevsForAdmin: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = AvgApi::Context::default();
    let result = client.getMrchtAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtGrAvgFieldForAdmin

This endpoint calculates the average value of a specific field (for example the amount) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getMrchtGrAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtGrAvgFieldForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getMrchtGrAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtGrAvgFieldForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (for example the amount) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrAvgFieldForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrAvgFieldForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (for example the amount) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedAvgResult result = apiInstance.getMrchtGrAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getMrchtGrAvgFieldForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getMrchtGrAvgFieldForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getMrchtGrAvgFieldForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getMrchtGrAvgFieldForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getMrchtGrAvgFieldForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (for example the amount) grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_avg_field_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getMrchtGrAvgFieldForAdmin: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = AvgApi::Context::default();
    let result = client.getMrchtGrAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getMrchtGrAvgFieldForPayoutsForAdmin

This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/payouts/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getMrchtGrAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtGrAvgFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getMrchtGrAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtGrAvgFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrAvgFieldForPayoutsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrAvgFieldForPayoutsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedAvgResult result = apiInstance.getMrchtGrAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getMrchtGrAvgFieldForPayoutsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getMrchtGrAvgFieldForPayoutsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getMrchtGrAvgFieldForPayoutsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getMrchtGrAvgFieldForPayoutsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getMrchtGrAvgFieldForPayoutsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_avg_field_for_payouts_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getMrchtGrAvgFieldForPayoutsForAdmin: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = AvgApi::Context::default();
    let result = client.getMrchtGrAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getMrchtGrAvgFieldForRefsAndRevsForAdmin

This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/refundsandreversals/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getMrchtGrAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtGrAvgFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getMrchtGrAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getMrchtGrAvgFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrAvgFieldForRefsAndRevsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrAvgFieldForRefsAndRevsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedAvgResult result = apiInstance.getMrchtGrAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getMrchtGrAvgFieldForRefsAndRevsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getMrchtGrAvgFieldForRefsAndRevsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getMrchtGrAvgFieldForRefsAndRevsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getMrchtGrAvgFieldForRefsAndRevsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getMrchtGrAvgFieldForRefsAndRevsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_avg_field_for_refs_and_revs_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getMrchtGrAvgFieldForRefsAndRevsForAdmin: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = AvgApi::Context::default();
    let result = client.getMrchtGrAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getPrtnOrMrchtAvgField

This endpoint calculates the average value of a field (for example the amount) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/avg/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/avg/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getPrtnOrMrchtAvgField(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtAvgField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getPrtnOrMrchtAvgField(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtAvgField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the average value of a field (for example the amount) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtAvgFieldWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtAvgField(field, idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtAvgFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the average value of a field (for example the amount) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateAvgResult result = apiInstance.getPrtnOrMrchtAvgField(field, idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getPrtnOrMrchtAvgField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtAvgField($field, $idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getPrtnOrMrchtAvgField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtAvgField(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getPrtnOrMrchtAvgField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the average value of a field (for example the amount) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_avg_field(field, idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getPrtnOrMrchtAvgField: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = AvgApi::Context::default();
    let result = client.getPrtnOrMrchtAvgField(field, idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtAvgFieldForPayouts

This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/avg/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/avg/payouts/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getPrtnOrMrchtAvgFieldForPayouts(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getPrtnOrMrchtAvgFieldForPayouts(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtAvgFieldForPayoutsWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtAvgFieldForPayouts(field, idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtAvgFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateAvgResult result = apiInstance.getPrtnOrMrchtAvgFieldForPayouts(field, idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getPrtnOrMrchtAvgFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtAvgFieldForPayouts($field, $idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getPrtnOrMrchtAvgFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtAvgFieldForPayouts(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getPrtnOrMrchtAvgFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_avg_field_for_payouts(field, idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getPrtnOrMrchtAvgFieldForPayouts: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = AvgApi::Context::default();
    let result = client.getPrtnOrMrchtAvgFieldForPayouts(field, idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtAvgFieldForRefsAndRevs

This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/avg/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/avg/refundsandreversals/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getPrtnOrMrchtAvgFieldForRefsAndRevs(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateAvgResult result = apiInstance.getPrtnOrMrchtAvgFieldForRefsAndRevs(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtAvgFieldForRefsAndRevsWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtAvgFieldForRefsAndRevs(field, idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtAvgFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateAvgResult result = apiInstance.getPrtnOrMrchtAvgFieldForRefsAndRevs(field, idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getPrtnOrMrchtAvgFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtAvgFieldForRefsAndRevs($field, $idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getPrtnOrMrchtAvgFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtAvgFieldForRefsAndRevs(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getPrtnOrMrchtAvgFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_avg_field_for_refs_and_revs(field, idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getPrtnOrMrchtAvgFieldForRefsAndRevs: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = AvgApi::Context::default();
    let result = client.getPrtnOrMrchtAvgFieldForRefsAndRevs(field, idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtGrAvgField

This endpoint calculates the average value of a field (for example the amount) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/avg/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/avg/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getPrtnOrMrchtGrAvgField(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtGrAvgField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getPrtnOrMrchtGrAvgField(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtGrAvgField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a field (for example the amount) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrAvgFieldWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrAvgField(field, idAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrAvgFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a field (for example the amount) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedAvgResult result = apiInstance.getPrtnOrMrchtGrAvgField(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getPrtnOrMrchtGrAvgField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getPrtnOrMrchtGrAvgField($field, $idAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getPrtnOrMrchtGrAvgField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrAvgField(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getPrtnOrMrchtGrAvgField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a field (for example the amount) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_avg_field(field, idAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getPrtnOrMrchtGrAvgField: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = AvgApi::Context::default();
    let result = client.getPrtnOrMrchtGrAvgField(field, idAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getPrtnOrMrchtGrAvgFieldForPayouts

This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/avg/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/avg/payouts/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getPrtnOrMrchtGrAvgFieldForPayouts(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtGrAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getPrtnOrMrchtGrAvgFieldForPayouts(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtGrAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrAvgFieldForPayoutsWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrAvgFieldForPayouts(field, idAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrAvgFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedAvgResult result = apiInstance.getPrtnOrMrchtGrAvgFieldForPayouts(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getPrtnOrMrchtGrAvgFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getPrtnOrMrchtGrAvgFieldForPayouts($field, $idAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getPrtnOrMrchtGrAvgFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrAvgFieldForPayouts(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getPrtnOrMrchtGrAvgFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_avg_field_for_payouts(field, idAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getPrtnOrMrchtGrAvgFieldForPayouts: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = AvgApi::Context::default();
    let result = client.getPrtnOrMrchtGrAvgFieldForPayouts(field, idAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getPrtnOrMrchtGrAvgFieldForRefsAndRevs

This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/avg/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/avg/refundsandreversals/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.AvgApi;

import java.io.File;
import java.util.*;

public class AvgApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getPrtnOrMrchtGrAvgFieldForRefsAndRevs(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtGrAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.AvgApi;

public class AvgApiExample {
    public static void main(String[] args) {
        AvgApi apiInstance = new AvgApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            AggregateGroupedAvgResult result = apiInstance.getPrtnOrMrchtGrAvgFieldForRefsAndRevs(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvgApi#getPrtnOrMrchtGrAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
AvgApi *apiInstance = [[AvgApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrAvgFieldForRefsAndRevsWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedAvgResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.AvgApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrAvgFieldForRefsAndRevs(field, idAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrAvgFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new AvgApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedAvgResult result = apiInstance.getPrtnOrMrchtGrAvgFieldForRefsAndRevs(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvgApi.getPrtnOrMrchtGrAvgFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvgApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getPrtnOrMrchtGrAvgFieldForRefsAndRevs($field, $idAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvgApi->getPrtnOrMrchtGrAvgFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::AvgApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::AvgApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrAvgFieldForRefsAndRevs(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AvgApi->getPrtnOrMrchtGrAvgFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.AvgApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_avg_field_for_refs_and_revs(field, idAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvgApi->getPrtnOrMrchtGrAvgFieldForRefsAndRevs: %s\n" % e)
extern crate AvgApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = AvgApi::Context::default();
    let result = client.getPrtnOrMrchtGrAvgFieldForRefsAndRevs(field, idAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


Count Endpoints

getGrPayoutsTxnsCount

This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/count/payouts

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/count/payouts?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getGrPayoutsTxnsCount(requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getGrPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getGrPayoutsTxnsCount(requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getGrPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGrPayoutsTxnsCountWith:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrPayoutsTxnsCount(requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrPayoutsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                AggregateGroupedCountResult result = apiInstance.getGrPayoutsTxnsCount(requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getGrPayoutsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getGrPayoutsTxnsCount($requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getGrPayoutsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getGrPayoutsTxnsCount(requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getGrPayoutsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_gr_payouts_txns_count(requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getGrPayoutsTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = CountApi::Context::default();
    let result = client.getGrPayoutsTxnsCount(requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getGrRefsAndRevsTxnsCount

This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/count/refundsandreversals

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/count/refundsandreversals?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getGrRefsAndRevsTxnsCount(requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getGrRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getGrRefsAndRevsTxnsCount(requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getGrRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGrRefsAndRevsTxnsCountWith:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrRefsAndRevsTxnsCount(requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrRefsAndRevsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                AggregateGroupedCountResult result = apiInstance.getGrRefsAndRevsTxnsCount(requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getGrRefsAndRevsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getGrRefsAndRevsTxnsCount($requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getGrRefsAndRevsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getGrRefsAndRevsTxnsCount(requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getGrRefsAndRevsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_gr_refs_and_revs_txns_count(requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getGrRefsAndRevsTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = CountApi::Context::default();
    let result = client.getGrRefsAndRevsTxnsCount(requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getGrTxnsCount

This endpoint counts the number of transactions and groups them by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/count

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/count?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getGrTxnsCount(requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getGrTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getGrTxnsCount(requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getGrTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending) (optional) (default to null)

// This endpoint counts the number of transactions and groups them by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGrTxnsCountWith:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the transactions. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrTxnsCount(requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending) (optional)  (default to null)

            try {
                // This endpoint counts the number of transactions and groups them by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                AggregateGroupedCountResult result = apiInstance.getGrTxnsCount(requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getGrTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)

try {
    $result = $api_instance->getGrTxnsCount($requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getGrTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the transactions. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)

eval { 
    my $result = $api_instance->getGrTxnsCount(requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getGrTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending) (optional) (default to null)

try: 
    # This endpoint counts the number of transactions and groups them by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_gr_txns_count(requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getGrTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = CountApi::Context::default();
    let result = client.getGrTxnsCount(requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the transactions. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)

Responses


getMrchtGrPayoutsTxnsCountForAdmin

This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/payouts

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/payouts?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getMrchtGrPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtGrPayoutsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getMrchtGrPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtGrPayoutsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrPayoutsTxnsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrPayoutsTxnsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedCountResult result = apiInstance.getMrchtGrPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getMrchtGrPayoutsTxnsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getMrchtGrPayoutsTxnsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getMrchtGrPayoutsTxnsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getMrchtGrPayoutsTxnsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getMrchtGrPayoutsTxnsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_payouts_txns_count_for_admin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getMrchtGrPayoutsTxnsCountForAdmin: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = CountApi::Context::default();
    let result = client.getMrchtGrPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getMrchtGrRefsAndRevsTxnsCountForAdmin

This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/refundsandreversals

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/refundsandreversals?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getMrchtGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtGrRefsAndRevsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getMrchtGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtGrRefsAndRevsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrRefsAndRevsTxnsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrRefsAndRevsTxnsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedCountResult result = apiInstance.getMrchtGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getMrchtGrRefsAndRevsTxnsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getMrchtGrRefsAndRevsTxnsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getMrchtGrRefsAndRevsTxnsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getMrchtGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getMrchtGrRefsAndRevsTxnsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_refs_and_revs_txns_count_for_admin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getMrchtGrRefsAndRevsTxnsCountForAdmin: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = CountApi::Context::default();
    let result = client.getMrchtGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getMrchtGrTxnsCountForAdmin

This endpoint counts the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getMrchtGrTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtGrTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getMrchtGrTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtGrTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrTxnsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the transactions. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrTxnsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedCountResult result = apiInstance.getMrchtGrTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getMrchtGrTxnsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getMrchtGrTxnsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getMrchtGrTxnsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the transactions. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getMrchtGrTxnsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getMrchtGrTxnsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_txns_count_for_admin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getMrchtGrTxnsCountForAdmin: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = CountApi::Context::default();
    let result = client.getMrchtGrTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the transactions. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getMrchtPayoutsTxnsCountForAdmin

This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count/payouts

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count/payouts"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtPayoutsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtPayoutsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtPayoutsTxnsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtPayoutsTxnsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getMrchtPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getMrchtPayoutsTxnsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtPayoutsTxnsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getMrchtPayoutsTxnsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtPayoutsTxnsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getMrchtPayoutsTxnsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_payouts_txns_count_for_admin(merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getMrchtPayoutsTxnsCountForAdmin: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = CountApi::Context::default();
    let result = client.getMrchtPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtRefsAndRevsTxnsCountForAdmin

This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count/refundsandreversals

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count/refundsandreversals"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtRefsAndRevsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtRefsAndRevsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtRefsAndRevsTxnsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtRefsAndRevsTxnsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getMrchtRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getMrchtRefsAndRevsTxnsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtRefsAndRevsTxnsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getMrchtRefsAndRevsTxnsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtRefsAndRevsTxnsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getMrchtRefsAndRevsTxnsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_refs_and_revs_txns_count_for_admin(merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getMrchtRefsAndRevsTxnsCountForAdmin: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = CountApi::Context::default();
    let result = client.getMrchtRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtTxnsCountForAdmin

This endpoint counts the number of transactions. 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getMrchtTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint counts the number of transactions. 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtTxnsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtTxnsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint counts the number of transactions. 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getMrchtTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getMrchtTxnsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtTxnsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getMrchtTxnsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtTxnsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getMrchtTxnsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint counts the number of transactions. 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_txns_count_for_admin(merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getMrchtTxnsCountForAdmin: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = CountApi::Context::default();
    let result = client.getMrchtTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPayoutsTxnsCount

This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
/transactions/aggregate/count/payouts

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/count/payouts"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPayoutsTxnsCount(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPayoutsTxnsCount(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
RequestConfig *requestConfig = ; // 

// This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
[apiInstance getPayoutsTxnsCountWith:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPayoutsTxnsCount(requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPayoutsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
                CountResult result = apiInstance.getPayoutsTxnsCount(requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getPayoutsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPayoutsTxnsCount($requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getPayoutsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPayoutsTxnsCount(requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getPayoutsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
requestConfig =  # RequestConfig | 

try: 
    # This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
    api_response = api_instance.get_payouts_txns_count(requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getPayoutsTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let requestConfig = ; // RequestConfig

    let mut context = CountApi::Context::default();
    let result = client.getPayoutsTxnsCount(requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtGrPayoutsTxnsCount

This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/count/payouts

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/count/payouts?groupBy=&calendarInterval="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        
        try {
            AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrPayoutsTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtGrPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        
        try {
            AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrPayoutsTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtGrPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)

// This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrPayoutsTxnsCountWith:idAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval':  // {CalendarInterval} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrPayoutsTxnsCount(idAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrPayoutsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrPayoutsTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getPrtnOrMrchtGrPayoutsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 

try {
    $result = $api_instance->getPrtnOrMrchtGrPayoutsTxnsCount($idAlpha, $requestConfig, $groupBy, $calendarInterval);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getPrtnOrMrchtGrPayoutsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrPayoutsTxnsCount(idAlpha => $idAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getPrtnOrMrchtGrPayoutsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_payouts_txns_count(idAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getPrtnOrMrchtGrPayoutsTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval

    let mut context = CountApi::Context::default();
    let result = client.getPrtnOrMrchtGrPayoutsTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

Responses


getPrtnOrMrchtGrRefsAndRevsTxnsCount

This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/count/refundsandreversals

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/count/refundsandreversals?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrRefsAndRevsTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtGrRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrRefsAndRevsTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtGrRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrRefsAndRevsTxnsCountWith:idAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrRefsAndRevsTxnsCount(idAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrRefsAndRevsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrRefsAndRevsTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getPrtnOrMrchtGrRefsAndRevsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getPrtnOrMrchtGrRefsAndRevsTxnsCount($idAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getPrtnOrMrchtGrRefsAndRevsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrRefsAndRevsTxnsCount(idAlpha => $idAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getPrtnOrMrchtGrRefsAndRevsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_refs_and_revs_txns_count(idAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getPrtnOrMrchtGrRefsAndRevsTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = CountApi::Context::default();
    let result = client.getPrtnOrMrchtGrRefsAndRevsTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getPrtnOrMrchtGrTxnsCount

This endpoint counts the number of transactions for a specific partner/merchant and groups them by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/count

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/count?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtGrTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtGrTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending) (optional) (default to null)

// This endpoint counts the number of transactions for a specific partner/merchant and groups them by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrTxnsCountWith:idAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the transactions. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrTxnsCount(idAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending) (optional)  (default to null)

            try {
                // This endpoint counts the number of transactions for a specific partner/merchant and groups them by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getPrtnOrMrchtGrTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)

try {
    $result = $api_instance->getPrtnOrMrchtGrTxnsCount($idAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getPrtnOrMrchtGrTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the transactions. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrTxnsCount(idAlpha => $idAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getPrtnOrMrchtGrTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending) (optional) (default to null)

try: 
    # This endpoint counts the number of transactions for a specific partner/merchant and groups them by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_txns_count(idAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getPrtnOrMrchtGrTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = CountApi::Context::default();
    let result = client.getPrtnOrMrchtGrTxnsCount(idAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the transactions. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)

Responses


getPrtnOrMrchtPayoutsTxnsCount

This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/count/payouts

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/count/payouts"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtPayoutsTxnsCount(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtPayoutsTxnsCount(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtPayoutsTxnsCountWith:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtPayoutsTxnsCount(idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtPayoutsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getPrtnOrMrchtPayoutsTxnsCount(idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getPrtnOrMrchtPayoutsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtPayoutsTxnsCount($idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getPrtnOrMrchtPayoutsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtPayoutsTxnsCount(idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getPrtnOrMrchtPayoutsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_payouts_txns_count(idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getPrtnOrMrchtPayoutsTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = CountApi::Context::default();
    let result = client.getPrtnOrMrchtPayoutsTxnsCount(idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtRefsAndRevsTxnsCount

This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/count/refundsandreversals

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/count/refundsandreversals"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtRefsAndRevsTxnsCount(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtRefsAndRevsTxnsCount(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtRefsAndRevsTxnsCountWith:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtRefsAndRevsTxnsCount(idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtRefsAndRevsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getPrtnOrMrchtRefsAndRevsTxnsCount(idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getPrtnOrMrchtRefsAndRevsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtRefsAndRevsTxnsCount($idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getPrtnOrMrchtRefsAndRevsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtRefsAndRevsTxnsCount(idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getPrtnOrMrchtRefsAndRevsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_refs_and_revs_txns_count(idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getPrtnOrMrchtRefsAndRevsTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = CountApi::Context::default();
    let result = client.getPrtnOrMrchtRefsAndRevsTxnsCount(idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtTxnsCount

This endpoint retrieves the total number of transaction for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/count

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/count"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtTxnsCount(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtTxnsCount(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getPrtnOrMrchtTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the total number of transaction for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtTxnsCountWith:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtTxnsCount(idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the total number of transaction for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getPrtnOrMrchtTxnsCount(idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getPrtnOrMrchtTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtTxnsCount($idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getPrtnOrMrchtTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtTxnsCount(idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getPrtnOrMrchtTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the total number of transaction for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_txns_count(idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getPrtnOrMrchtTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = CountApi::Context::default();
    let result = client.getPrtnOrMrchtTxnsCount(idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getRefsAndRevsTxnsCount

This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
/transactions/aggregate/count/refundsandreversals

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/count/refundsandreversals"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getRefsAndRevsTxnsCount(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getRefsAndRevsTxnsCount(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
RequestConfig *requestConfig = ; // 

// This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
[apiInstance getRefsAndRevsTxnsCountWith:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRefsAndRevsTxnsCount(requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getRefsAndRevsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
                CountResult result = apiInstance.getRefsAndRevsTxnsCount(requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getRefsAndRevsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getRefsAndRevsTxnsCount($requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getRefsAndRevsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getRefsAndRevsTxnsCount(requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getRefsAndRevsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
requestConfig =  # RequestConfig | 

try: 
    # This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
    api_response = api_instance.get_refs_and_revs_txns_count(requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getRefsAndRevsTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let requestConfig = ; // RequestConfig

    let mut context = CountApi::Context::default();
    let result = client.getRefsAndRevsTxnsCount(requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Body parameters
Name Description
requestConfig *

Request filters

Responses


getTxnsCount

This endpoint retrieves the total number of transaction for a partner/merchant.
/transactions/aggregate/count

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/count"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.CountApi;

import java.io.File;
import java.util.*;

public class CountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getTxnsCount(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.CountApi;

public class CountApiExample {
    public static void main(String[] args) {
        CountApi apiInstance = new CountApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getTxnsCount(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountApi#getTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
CountApi *apiInstance = [[CountApi alloc] init];
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the total number of transaction for a partner/merchant.
[apiInstance getTxnsCountWith:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.CountApi()
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTxnsCount(requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new CountApi();
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the total number of transaction for a partner/merchant.
                CountResult result = apiInstance.getTxnsCount(requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CountApi.getTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CountApi();
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getTxnsCount($requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountApi->getTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::CountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::CountApi->new();
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getTxnsCount(requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountApi->getTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.CountApi()
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the total number of transaction for a partner/merchant.
    api_response = api_instance.get_txns_count(requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountApi->getTxnsCount: %s\n" % e)
extern crate CountApi;

pub fn main() {
    let requestConfig = ; // RequestConfig

    let mut context = CountApi::Context::default();
    let result = client.getTxnsCount(requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Body parameters
Name Description
requestConfig *

Request filters

Responses


DistinctCount Endpoints

getDistFieldCount

This endpoint retrieves the number of distinct "field values".
/transactions/aggregate/count/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/count/distinct/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getDistFieldCount(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getDistFieldCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getDistFieldCount(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getDistFieldCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the number of distinct "field values".
[apiInstance getDistFieldCountWith:field
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDistFieldCount(field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getDistFieldCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the number of distinct "field values".
                CountResult result = apiInstance.getDistFieldCount(field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getDistFieldCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getDistFieldCount($field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getDistFieldCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getDistFieldCount(field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getDistFieldCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the number of distinct "field values".
    api_response = api_instance.get_dist_field_count(field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getDistFieldCount: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = DistinctCountApi::Context::default();
    let result = client.getDistFieldCount(field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getDistFieldPayoutsCount

This endpoint retrieves the number of distinct "field values" for a specific field among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
/transactions/aggregate/count/payouts/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/count/payouts/distinct/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getDistFieldPayoutsCount(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getDistFieldPayoutsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getDistFieldPayoutsCount(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getDistFieldPayoutsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the number of distinct "field values" for a specific field among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
[apiInstance getDistFieldPayoutsCountWith:field
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDistFieldPayoutsCount(field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getDistFieldPayoutsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the number of distinct "field values" for a specific field among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
                CountResult result = apiInstance.getDistFieldPayoutsCount(field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getDistFieldPayoutsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getDistFieldPayoutsCount($field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getDistFieldPayoutsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getDistFieldPayoutsCount(field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getDistFieldPayoutsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the number of distinct "field values" for a specific field among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
    api_response = api_instance.get_dist_field_payouts_count(field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getDistFieldPayoutsCount: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = DistinctCountApi::Context::default();
    let result = client.getDistFieldPayoutsCount(field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getDistFieldRefsAndRevsCount

This endpoint retrieves the number of distinct "field values" for a specific field among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
/transactions/aggregate/count/refundsandreversals/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/count/refundsandreversals/distinct/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getDistFieldRefsAndRevsCount(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getDistFieldRefsAndRevsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getDistFieldRefsAndRevsCount(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getDistFieldRefsAndRevsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the number of distinct "field values" for a specific field among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
[apiInstance getDistFieldRefsAndRevsCountWith:field
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDistFieldRefsAndRevsCount(field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getDistFieldRefsAndRevsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the number of distinct "field values" for a specific field among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
                CountResult result = apiInstance.getDistFieldRefsAndRevsCount(field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getDistFieldRefsAndRevsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getDistFieldRefsAndRevsCount($field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getDistFieldRefsAndRevsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getDistFieldRefsAndRevsCount(field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getDistFieldRefsAndRevsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the number of distinct "field values" for a specific field among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
    api_response = api_instance.get_dist_field_refs_and_revs_count(field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getDistFieldRefsAndRevsCount: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = DistinctCountApi::Context::default();
    let result = client.getDistFieldRefsAndRevsCount(field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getGrDistFieldCount

This endpoint retrieves the number of distinct "field values and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/count/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/count/distinct/{field}?calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getGrDistFieldCount(field, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getGrDistFieldCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getGrDistFieldCount(field, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getGrDistFieldCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint retrieves the number of distinct "field values and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGrDistFieldCountWith:field
    requestConfig:requestConfig
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 
var opts = {
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrDistFieldCount(field, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrDistFieldCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint retrieves the number of distinct "field values and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                AggregateGroupedCountResult result = apiInstance.getGrDistFieldCount(field, requestConfig, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getGrDistFieldCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getGrDistFieldCount($field, $requestConfig, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getGrDistFieldCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getGrDistFieldCount(field => $field, requestConfig => $requestConfig, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getGrDistFieldCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint retrieves the number of distinct "field values and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_gr_dist_field_count(field, requestConfig, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getGrDistFieldCount: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = DistinctCountApi::Context::default();
    let result = client.getGrDistFieldCount(field, requestConfig, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getMrchtDistFieldCountForAdmin

This endpoint retrieves the number of distinct "field values". 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count/distinct/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getMrchtDistFieldCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getMrchtDistFieldCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the number of distinct "field values". 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtDistFieldCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    field:field
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtDistFieldCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the number of distinct "field values". 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getMrchtDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getMrchtDistFieldCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtDistFieldCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getMrchtDistFieldCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtDistFieldCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getMrchtDistFieldCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the number of distinct "field values". 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_dist_field_count_for_admin(merchantIdAlpha, partnerIdAlpha, field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getMrchtDistFieldCountForAdmin: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = DistinctCountApi::Context::default();
    let result = client.getMrchtDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtDistFieldPayoutsCountForAdmin

This endpoint retrieves the number of distinct "field values" among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count/payouts/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count/payouts/distinct/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtDistFieldPayoutsCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getMrchtDistFieldPayoutsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtDistFieldPayoutsCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getMrchtDistFieldPayoutsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the number of distinct "field values" among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtDistFieldPayoutsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    field:field
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtDistFieldPayoutsCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtDistFieldPayoutsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the number of distinct "field values" among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getMrchtDistFieldPayoutsCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getMrchtDistFieldPayoutsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtDistFieldPayoutsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getMrchtDistFieldPayoutsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtDistFieldPayoutsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getMrchtDistFieldPayoutsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the number of distinct "field values" among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_dist_field_payouts_count_for_admin(merchantIdAlpha, partnerIdAlpha, field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getMrchtDistFieldPayoutsCountForAdmin: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = DistinctCountApi::Context::default();
    let result = client.getMrchtDistFieldPayoutsCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtDistFieldRefsAndRevsCountForAdmin

This endpoint retrieves the number of distinct "field values" among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count/refundsandreversals/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/count/refundsandreversals/distinct/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtDistFieldRefsAndRevsCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getMrchtDistFieldRefsAndRevsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getMrchtDistFieldRefsAndRevsCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getMrchtDistFieldRefsAndRevsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the number of distinct "field values" among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtDistFieldRefsAndRevsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    field:field
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtDistFieldRefsAndRevsCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtDistFieldRefsAndRevsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the number of distinct "field values" among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getMrchtDistFieldRefsAndRevsCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getMrchtDistFieldRefsAndRevsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtDistFieldRefsAndRevsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getMrchtDistFieldRefsAndRevsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtDistFieldRefsAndRevsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getMrchtDistFieldRefsAndRevsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the number of distinct "field values" among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_dist_field_refs_and_revs_count_for_admin(merchantIdAlpha, partnerIdAlpha, field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getMrchtDistFieldRefsAndRevsCountForAdmin: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = DistinctCountApi::Context::default();
    let result = client.getMrchtDistFieldRefsAndRevsCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtGrDistFieldCountForAdmin

This endpoint retrieves the number of distinct "field values and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/distinct/{field}?calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getMrchtGrDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getMrchtGrDistFieldCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getMrchtGrDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getMrchtGrDistFieldCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint retrieves the number of distinct "field values and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrDistFieldCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    field:field
    requestConfig:requestConfig
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 
var opts = {
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrDistFieldCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint retrieves the number of distinct "field values and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedCountResult result = apiInstance.getMrchtGrDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getMrchtGrDistFieldCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getMrchtGrDistFieldCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $field, $requestConfig, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getMrchtGrDistFieldCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getMrchtGrDistFieldCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, field => $field, requestConfig => $requestConfig, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getMrchtGrDistFieldCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint retrieves the number of distinct "field values and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_dist_field_count_for_admin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getMrchtGrDistFieldCountForAdmin: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let field = field_example; // String
    let requestConfig = ; // RequestConfig
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = DistinctCountApi::Context::default();
    let result = client.getMrchtGrDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, requestConfig, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getPrtnOrMrchtDistFieldCount

This endpoint retrieves the number of distinct "field values" for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/count/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/count/distinct/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtDistFieldCount(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getPrtnOrMrchtDistFieldCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtDistFieldCount(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getPrtnOrMrchtDistFieldCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the number of distinct "field values" for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtDistFieldCountWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtDistFieldCount(field, idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtDistFieldCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the number of distinct "field values" for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getPrtnOrMrchtDistFieldCount(field, idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getPrtnOrMrchtDistFieldCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtDistFieldCount($field, $idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getPrtnOrMrchtDistFieldCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtDistFieldCount(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getPrtnOrMrchtDistFieldCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the number of distinct "field values" for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_dist_field_count(field, idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getPrtnOrMrchtDistFieldCount: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = DistinctCountApi::Context::default();
    let result = client.getPrtnOrMrchtDistFieldCount(field, idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtDistFieldPayoutsCount

This endpoint retrieves the number of distinct "field values" for a specific field and a specific partner/merchant among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/count/payouts/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/count/payouts/distinct/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtDistFieldPayoutsCount(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getPrtnOrMrchtDistFieldPayoutsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtDistFieldPayoutsCount(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getPrtnOrMrchtDistFieldPayoutsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the number of distinct "field values" for a specific field and a specific partner/merchant among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtDistFieldPayoutsCountWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtDistFieldPayoutsCount(field, idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtDistFieldPayoutsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the number of distinct "field values" for a specific field and a specific partner/merchant among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getPrtnOrMrchtDistFieldPayoutsCount(field, idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getPrtnOrMrchtDistFieldPayoutsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtDistFieldPayoutsCount($field, $idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getPrtnOrMrchtDistFieldPayoutsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtDistFieldPayoutsCount(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getPrtnOrMrchtDistFieldPayoutsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the number of distinct "field values" for a specific field and a specific partner/merchant among all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_dist_field_payouts_count(field, idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getPrtnOrMrchtDistFieldPayoutsCount: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = DistinctCountApi::Context::default();
    let result = client.getPrtnOrMrchtDistFieldPayoutsCount(field, idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtDistFieldRefsAndRevsCount

This endpoint retrieves the number of distinct "field values" for a specific field and a specific partner/merchant among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/count/refundsandreversals/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/count/refundsandreversals/distinct/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtDistFieldRefsAndRevsCount(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getPrtnOrMrchtDistFieldRefsAndRevsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            CountResult result = apiInstance.getPrtnOrMrchtDistFieldRefsAndRevsCount(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getPrtnOrMrchtDistFieldRefsAndRevsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the number of distinct "field values" for a specific field and a specific partner/merchant among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtDistFieldRefsAndRevsCountWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(CountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtDistFieldRefsAndRevsCount(field, idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtDistFieldRefsAndRevsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the number of distinct "field values" for a specific field and a specific partner/merchant among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                CountResult result = apiInstance.getPrtnOrMrchtDistFieldRefsAndRevsCount(field, idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getPrtnOrMrchtDistFieldRefsAndRevsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtDistFieldRefsAndRevsCount($field, $idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getPrtnOrMrchtDistFieldRefsAndRevsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtDistFieldRefsAndRevsCount(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getPrtnOrMrchtDistFieldRefsAndRevsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the number of distinct "field values" for a specific field and a specific partner/merchant among all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_dist_field_refs_and_revs_count(field, idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getPrtnOrMrchtDistFieldRefsAndRevsCount: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = DistinctCountApi::Context::default();
    let result = client.getPrtnOrMrchtDistFieldRefsAndRevsCount(field, idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtGrDistFieldCount

This endpoint retrieves the number of distinct "field values for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/count/distinct/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/count/distinct/{field}?calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.DistinctCountApi;

import java.io.File;
import java.util.*;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        DistinctCountApi apiInstance = new DistinctCountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrDistFieldCount(idAlpha, field, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getPrtnOrMrchtGrDistFieldCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.DistinctCountApi;

public class DistinctCountApiExample {
    public static void main(String[] args) {
        DistinctCountApi apiInstance = new DistinctCountApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrDistFieldCount(idAlpha, field, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistinctCountApi#getPrtnOrMrchtGrDistFieldCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
DistinctCountApi *apiInstance = [[DistinctCountApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint retrieves the number of distinct "field values for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrDistFieldCountWith:idAlpha
    field:field
    requestConfig:requestConfig
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedCountResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.DistinctCountApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 
var opts = {
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrDistFieldCount(idAlpha, field, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrDistFieldCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new DistinctCountApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint retrieves the number of distinct "field values for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedCountResult result = apiInstance.getPrtnOrMrchtGrDistFieldCount(idAlpha, field, requestConfig, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DistinctCountApi.getPrtnOrMrchtGrDistFieldCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DistinctCountApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getPrtnOrMrchtGrDistFieldCount($idAlpha, $field, $requestConfig, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistinctCountApi->getPrtnOrMrchtGrDistFieldCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::DistinctCountApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::DistinctCountApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrDistFieldCount(idAlpha => $idAlpha, field => $field, requestConfig => $requestConfig, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistinctCountApi->getPrtnOrMrchtGrDistFieldCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.DistinctCountApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint retrieves the number of distinct "field values for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_dist_field_count(idAlpha, field, requestConfig, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistinctCountApi->getPrtnOrMrchtGrDistFieldCount: %s\n" % e)
extern crate DistinctCountApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let field = field_example; // String
    let requestConfig = ; // RequestConfig
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = DistinctCountApi::Context::default();
    let result = client.getPrtnOrMrchtGrDistFieldCount(idAlpha, field, requestConfig, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


Graph Endpoints

getGraphGrAvgField

This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/avg/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/avg/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getGraphGrAvgField(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrAvgField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getGraphGrAvgField(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrAvgField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGraphGrAvgFieldWith:field
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrAvgField(field, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrAvgFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                GraphResult result = apiInstance.getGraphGrAvgField(field, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrAvgField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getGraphGrAvgField($field, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrAvgField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getGraphGrAvgField(field => $field, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrAvgField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_graph_gr_avg_field(field, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrAvgField: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrAvgField(field, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getGraphGrAvgFieldForPayouts

This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC')
/transactions/aggregate/group/avg/payouts/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/avg/payouts/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getGraphGrAvgFieldForPayouts(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getGraphGrAvgFieldForPayouts(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC')
[apiInstance getGraphGrAvgFieldForPayoutsWith:field
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrAvgFieldForPayouts(field, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrAvgFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC')
                GraphResult result = apiInstance.getGraphGrAvgFieldForPayouts(field, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrAvgFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getGraphGrAvgFieldForPayouts($field, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrAvgFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getGraphGrAvgFieldForPayouts(field => $field, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrAvgFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC')
    api_response = api_instance.get_graph_gr_avg_field_for_payouts(field, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrAvgFieldForPayouts: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrAvgFieldForPayouts(field, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getGraphGrAvgFieldForRefsAndRevs

This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/avg/refundsandreversals/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/avg/refundsandreversals/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getGraphGrAvgFieldForRefsAndRevs(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getGraphGrAvgFieldForRefsAndRevs(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGraphGrAvgFieldForRefsAndRevsWith:field
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrAvgFieldForRefsAndRevs(field, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrAvgFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                GraphResult result = apiInstance.getGraphGrAvgFieldForRefsAndRevs(field, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrAvgFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getGraphGrAvgFieldForRefsAndRevs($field, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrAvgFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getGraphGrAvgFieldForRefsAndRevs(field => $field, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrAvgFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_graph_gr_avg_field_for_refs_and_revs(field, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrAvgFieldForRefsAndRevs: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrAvgFieldForRefsAndRevs(field, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getGraphGrDistFieldCount

This endpoint retrieves the number of distinct "field values and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/count/distinct/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/count/distinct/{field}/graph/{graphType}?calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getGraphGrDistFieldCount(field, graphType, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrDistFieldCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getGraphGrDistFieldCount(field, graphType, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrDistFieldCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint retrieves the number of distinct "field values and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGraphGrDistFieldCountWith:field
    graphType:graphType
    requestConfig:requestConfig
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrDistFieldCount(field, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrDistFieldCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint retrieves the number of distinct "field values and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                GraphResult result = apiInstance.getGraphGrDistFieldCount(field, graphType, requestConfig, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrDistFieldCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getGraphGrDistFieldCount($field, $graphType, $requestConfig, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrDistFieldCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getGraphGrDistFieldCount(field => $field, graphType => $graphType, requestConfig => $requestConfig, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrDistFieldCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint retrieves the number of distinct "field values and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_graph_gr_dist_field_count(field, graphType, requestConfig, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrDistFieldCount: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrDistFieldCount(field, graphType, requestConfig, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getGraphGrNetField

This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/net/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/net/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            GraphResult result = apiInstance.getGraphGrNetField(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrNetField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            GraphResult result = apiInstance.getGraphGrNetField(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrNetField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

// This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGraphGrNetFieldWith:field
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalNet
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrNetField(field, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrNetFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional)  (default to null)

            try {
                // This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                GraphResult result = apiInstance.getGraphGrNetField(field, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrNetField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

try {
    $result = $api_instance->getGraphGrNetField($field, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrNetField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

eval { 
    my $result = $api_instance->getGraphGrNetField(field => $field, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrNetField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

try: 
    # This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_graph_gr_net_field(field, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrNetField: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrNetField(field, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalNet

Responses


getGraphGrPayoutsTxnsCount

This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/count/payouts/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/count/payouts/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getGraphGrPayoutsTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getGraphGrPayoutsTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGraphGrPayoutsTxnsCountWith:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrPayoutsTxnsCount(graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrPayoutsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                GraphResult result = apiInstance.getGraphGrPayoutsTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrPayoutsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getGraphGrPayoutsTxnsCount($graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrPayoutsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getGraphGrPayoutsTxnsCount(graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrPayoutsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_graph_gr_payouts_txns_count(graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrPayoutsTxnsCount: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrPayoutsTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getGraphGrRefsAndRevsTxnsCount

This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/count/refundsandreversals/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/count/refundsandreversals/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getGraphGrRefsAndRevsTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getGraphGrRefsAndRevsTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGraphGrRefsAndRevsTxnsCountWith:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrRefsAndRevsTxnsCount(graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrRefsAndRevsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                GraphResult result = apiInstance.getGraphGrRefsAndRevsTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrRefsAndRevsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getGraphGrRefsAndRevsTxnsCount($graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrRefsAndRevsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getGraphGrRefsAndRevsTxnsCount(graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrRefsAndRevsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_graph_gr_refs_and_revs_txns_count(graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrRefsAndRevsTxnsCount: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrRefsAndRevsTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getGraphGrSumField

This endpoint sums up the values of a specific field (for example the amount) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/sum/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/sum/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getGraphGrSumField(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrSumField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getGraphGrSumField(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrSumField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint sums up the values of a specific field (for example the amount) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGraphGrSumFieldWith:field
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrSumField(field, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrSumFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint sums up the values of a specific field (for example the amount) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                GraphResult result = apiInstance.getGraphGrSumField(field, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrSumField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getGraphGrSumField($field, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrSumField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getGraphGrSumField(field => $field, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrSumField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint sums up the values of a specific field (for example the amount) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_graph_gr_sum_field(field, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrSumField: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrSumField(field, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getGraphGrSumFieldForPayouts

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/sum/payouts/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/sum/payouts/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getGraphGrSumFieldForPayouts(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getGraphGrSumFieldForPayouts(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGraphGrSumFieldForPayoutsWith:field
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrSumFieldForPayouts(field, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrSumFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                GraphResult result = apiInstance.getGraphGrSumFieldForPayouts(field, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrSumFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getGraphGrSumFieldForPayouts($field, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrSumFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getGraphGrSumFieldForPayouts(field => $field, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrSumFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_graph_gr_sum_field_for_payouts(field, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrSumFieldForPayouts: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrSumFieldForPayouts(field, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getGraphGrSumFieldForRefsAndRevs

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/sum/refundsandreversals/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/sum/refundsandreversals/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getGraphGrSumFieldForRefsAndRevs(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getGraphGrSumFieldForRefsAndRevs(field, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGraphGrSumFieldForRefsAndRevsWith:field
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrSumFieldForRefsAndRevs(field, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrSumFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                GraphResult result = apiInstance.getGraphGrSumFieldForRefsAndRevs(field, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrSumFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getGraphGrSumFieldForRefsAndRevs($field, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrSumFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getGraphGrSumFieldForRefsAndRevs(field => $field, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrSumFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_graph_gr_sum_field_for_refs_and_revs(field, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrSumFieldForRefsAndRevs: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrSumFieldForRefsAndRevs(field, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getGraphGrTxnsCount

This endpoint counts and creates a graph of the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/count/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/count/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)
        
        try {
            GraphResult result = apiInstance.getGraphGrTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)
        
        try {
            GraphResult result = apiInstance.getGraphGrTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getGraphGrTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending) (optional) (default to null)

// This endpoint counts and creates a graph of the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGraphGrTxnsCountWith:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the transactions. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGraphGrTxnsCount(graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGraphGrTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending) (optional)  (default to null)

            try {
                // This endpoint counts and creates a graph of the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                GraphResult result = apiInstance.getGraphGrTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getGraphGrTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)

try {
    $result = $api_instance->getGraphGrTxnsCount($graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getGraphGrTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the transactions. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)

eval { 
    my $result = $api_instance->getGraphGrTxnsCount(graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getGraphGrTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending) (optional) (default to null)

try: 
    # This endpoint counts and creates a graph of the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_graph_gr_txns_count(graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getGraphGrTxnsCount: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getGraphGrTxnsCount(graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the transactions. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to sort the transactions in a specified order (ascending or descending)

Responses


getMrchtGraphGrAvgFieldForAdmin

This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrAvgFieldForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrAvgFieldForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrAvgFieldForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrAvgFieldForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrAvgFieldForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getMrchtGraphGrAvgFieldForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrAvgFieldForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getMrchtGraphGrAvgFieldForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrAvgFieldForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_avg_field_for_admin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrAvgFieldForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrAvgFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getMrchtGraphGrAvgFieldForPayoutsForAdmin

This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/payouts/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/payouts/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrAvgFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrAvgFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrAvgFieldForPayoutsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrAvgFieldForPayoutsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrAvgFieldForPayoutsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getMrchtGraphGrAvgFieldForPayoutsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrAvgFieldForPayoutsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getMrchtGraphGrAvgFieldForPayoutsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrAvgFieldForPayoutsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount field) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_avg_field_for_payouts_for_admin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrAvgFieldForPayoutsForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrAvgFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin

This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/refundsandreversals/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/avg/refundsandreversals/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrAvgFieldForRefsAndRevsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrAvgFieldForRefsAndRevsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_avg_field_for_refs_and_revs_for_admin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrAvgFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getMrchtGraphGrDistFieldCountForAdmin

This endpoint retrieves the number of distinct "field values and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/distinct/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/distinct/{field}/graph/{graphType}?calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, graphType, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrDistFieldCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, graphType, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrDistFieldCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
String *field = field_example; // Field to be targeted for the aggregation (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint retrieves the number of distinct "field values and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrDistFieldCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    field:field
    graphType:graphType
    requestConfig:requestConfig
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var field = field_example; // {String} Field to be targeted for the aggregation
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrDistFieldCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint retrieves the number of distinct "field values and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, graphType, requestConfig, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrDistFieldCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$field = field_example; // String | Field to be targeted for the aggregation
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getMrchtGraphGrDistFieldCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $field, $graphType, $requestConfig, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrDistFieldCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $field = field_example; # String | Field to be targeted for the aggregation
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getMrchtGraphGrDistFieldCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, field => $field, graphType => $graphType, requestConfig => $requestConfig, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrDistFieldCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
field = field_example # String | Field to be targeted for the aggregation (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint retrieves the number of distinct "field values and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_dist_field_count_for_admin(merchantIdAlpha, partnerIdAlpha, field, graphType, requestConfig, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrDistFieldCountForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let field = field_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrDistFieldCountForAdmin(merchantIdAlpha, partnerIdAlpha, field, graphType, requestConfig, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

field *

Field to be targeted for the aggregation

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getMrchtGraphGrNetFieldForAdmin

This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/net/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/net/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrNetFieldForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrNetFieldForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

// This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrNetFieldForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalNet
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrNetFieldForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional)  (default to null)

            try {
                // This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrNetFieldForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

try {
    $result = $api_instance->getMrchtGraphGrNetFieldForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrNetFieldForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

eval { 
    my $result = $api_instance->getMrchtGraphGrNetFieldForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrNetFieldForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

try: 
    # This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_net_field_for_admin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrNetFieldForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalNet

Responses


getMrchtGraphGrPayoutsTxnsCountForAdmin

This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/payouts/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/payouts/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrPayoutsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrPayoutsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrPayoutsTxnsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrPayoutsTxnsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrPayoutsTxnsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getMrchtGraphGrPayoutsTxnsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrPayoutsTxnsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getMrchtGraphGrPayoutsTxnsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrPayoutsTxnsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_payouts_txns_count_for_admin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrPayoutsTxnsCountForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrPayoutsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getMrchtGraphGrRefsAndRevsTxnsCountForAdmin

This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/refundsandreversals/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/refundsandreversals/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrRefsAndRevsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrRefsAndRevsTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrRefsAndRevsTxnsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrRefsAndRevsTxnsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrRefsAndRevsTxnsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getMrchtGraphGrRefsAndRevsTxnsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrRefsAndRevsTxnsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getMrchtGraphGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrRefsAndRevsTxnsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_refs_and_revs_txns_count_for_admin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrRefsAndRevsTxnsCountForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrRefsAndRevsTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getMrchtGraphGrSumFieldForAdmin

This endpoint sums up the values of a field (for example the amount) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrSumFieldForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrSumFieldForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint sums up the values of a field (for example the amount) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrSumFieldForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrSumFieldForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint sums up the values of a field (for example the amount) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrSumFieldForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getMrchtGraphGrSumFieldForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrSumFieldForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getMrchtGraphGrSumFieldForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrSumFieldForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint sums up the values of a field (for example the amount) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_sum_field_for_admin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrSumFieldForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getMrchtGraphGrSumFieldForPayoutsForAdmin

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/payouts/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/payouts/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrSumFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrSumFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrSumFieldForPayoutsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrSumFieldForPayoutsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrSumFieldForPayoutsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getMrchtGraphGrSumFieldForPayoutsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrSumFieldForPayoutsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getMrchtGraphGrSumFieldForPayoutsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrSumFieldForPayoutsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_sum_field_for_payouts_for_admin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrSumFieldForPayoutsForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getMrchtGraphGrSumFieldForRefsAndRevsForAdmin

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/refundsandreversals/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/refundsandreversals/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrSumFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrSumFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrSumFieldForRefsAndRevsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrSumFieldForRefsAndRevsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrSumFieldForRefsAndRevsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getMrchtGraphGrSumFieldForRefsAndRevsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrSumFieldForRefsAndRevsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getMrchtGraphGrSumFieldForRefsAndRevsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrSumFieldForRefsAndRevsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_sum_field_for_refs_and_revs_for_admin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrSumFieldForRefsAndRevsForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getMrchtGraphGrTxnsCountForAdmin

This endpoint counts and creates a graph of the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/count/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getMrchtGraphGrTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getMrchtGraphGrTxnsCountForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts and creates a graph of the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGraphGrTxnsCountForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the transactions. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGraphGrTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGraphGrTxnsCountForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts and creates a graph of the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getMrchtGraphGrTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getMrchtGraphGrTxnsCountForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getMrchtGraphGrTxnsCountForAdmin($merchantIdAlpha, $partnerIdAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getMrchtGraphGrTxnsCountForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the transactions. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getMrchtGraphGrTxnsCountForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getMrchtGraphGrTxnsCountForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts and creates a graph of the number of transactions grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_graph_gr_txns_count_for_admin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getMrchtGraphGrTxnsCountForAdmin: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getMrchtGraphGrTxnsCountForAdmin(merchantIdAlpha, partnerIdAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the transactions. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getPrtnOrMrchtGraphGrAvgField

This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/avg/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/avg/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrAvgField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrAvgField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrAvgField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrAvgField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrAvgFieldWith:field
    idAlpha:idAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrAvgField(field, idAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrAvgFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrAvgField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrAvgField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrAvgField($field, $idAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrAvgField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrAvgField(field => $field, idAlpha => $idAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrAvgField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (for example the amount) and serves the graph of the specific field for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_avg_field(field, idAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrAvgField: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrAvgField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getPrtnOrMrchtGraphGrAvgFieldForPayouts

This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/avg/payouts/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/avg/payouts/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrAvgFieldForPayouts(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrAvgFieldForPayouts(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrAvgFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrAvgFieldForPayoutsWith:field
    idAlpha:idAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrAvgFieldForPayouts(field, idAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrAvgFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrAvgFieldForPayouts(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrAvgFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrAvgFieldForPayouts($field, $idAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrAvgFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrAvgFieldForPayouts(field => $field, idAlpha => $idAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrAvgFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_avg_field_for_payouts(field, idAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrAvgFieldForPayouts: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrAvgFieldForPayouts(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs

This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/avg/refundsandreversals/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/avg/refundsandreversals/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

// This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevsWith:field
    idAlpha:idAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalAvg
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs(field, idAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional)  (default to null)

            try {
                // This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs($field, $idAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs(field => $field, idAlpha => $idAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalAvg (optional) (default to null)

try: 
    # This endpoint calculates the average value of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_avg_field_for_refs_and_revs(field, idAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrAvgFieldForRefsAndRevs(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalAvg

Responses


getPrtnOrMrchtGraphGrDistFieldCount

This endpoint retrieves the number of distinct "field values for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/count/distinct/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/count/distinct/{field}/graph/{graphType}?calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrDistFieldCount(idAlpha, field, graphType, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrDistFieldCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        String field = field_example; // String | Field to be targeted for the aggregation
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrDistFieldCount(idAlpha, field, graphType, requestConfig, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrDistFieldCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
String *field = field_example; // Field to be targeted for the aggregation (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint retrieves the number of distinct "field values for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrDistFieldCountWith:idAlpha
    field:field
    graphType:graphType
    requestConfig:requestConfig
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var field = field_example; // {String} Field to be targeted for the aggregation
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrDistFieldCount(idAlpha, field, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrDistFieldCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint retrieves the number of distinct "field values for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrDistFieldCount(idAlpha, field, graphType, requestConfig, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrDistFieldCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$field = field_example; // String | Field to be targeted for the aggregation
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrDistFieldCount($idAlpha, $field, $graphType, $requestConfig, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrDistFieldCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $field = field_example; # String | Field to be targeted for the aggregation
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrDistFieldCount(idAlpha => $idAlpha, field => $field, graphType => $graphType, requestConfig => $requestConfig, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrDistFieldCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
field = field_example # String | Field to be targeted for the aggregation (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint retrieves the number of distinct "field values for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_dist_field_count(idAlpha, field, graphType, requestConfig, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrDistFieldCount: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let field = field_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrDistFieldCount(idAlpha, field, graphType, requestConfig, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

field *

Field to be targeted for the aggregation

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getPrtnOrMrchtGraphGrNetField

This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/net/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/net/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrNetField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrNetField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrNetField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrNetField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

// This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrNetFieldWith:field
    idAlpha:idAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalNet
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrNetField(field, idAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrNetFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional)  (default to null)

            try {
                // This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrNetField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrNetField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrNetField($field, $idAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrNetField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrNetField(field => $field, idAlpha => $idAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrNetField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

try: 
    # This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. Results are served as a graph and grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_net_field(field, idAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrNetField: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrNetField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalNet

Responses


getPrtnOrMrchtGraphGrPayoutsTxnsCount

This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/count/payouts/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/count/payouts/graph/{graphType}?groupBy=&calendarInterval="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrPayoutsTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrPayoutsTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrPayoutsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)

// This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrPayoutsTxnsCountWith:idAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval':  // {CalendarInterval} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrPayoutsTxnsCount(idAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrPayoutsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrPayoutsTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrPayoutsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrPayoutsTxnsCount($idAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrPayoutsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrPayoutsTxnsCount(idAlpha => $idAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrPayoutsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_payouts_txns_count(idAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrPayoutsTxnsCount: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrPayoutsTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

Responses


getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount

This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/count/refundsandreversals/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/count/refundsandreversals/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrRefsAndRevsTxnsCountWith:idAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount(idAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrRefsAndRevsTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount($idAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount(idAlpha => $idAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_refs_and_revs_txns_count(idAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrRefsAndRevsTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


getPrtnOrMrchtGraphGrSumField

This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/sum/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/sum/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrSumField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrSumField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrSumField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrSumField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrSumFieldWith:field
    idAlpha:idAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrSumField(field, idAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrSumFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrSumField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrSumField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrSumField($field, $idAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrSumField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrSumField(field => $field, idAlpha => $idAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrSumField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_sum_field(field, idAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrSumField: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrSumField(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getPrtnOrMrchtGraphGrSumFieldForPayouts

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/sum/payouts/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/sum/payouts/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrSumFieldForPayouts(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrSumFieldForPayouts(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrSumFieldForPayoutsWith:field
    idAlpha:idAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrSumFieldForPayouts(field, idAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrSumFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrSumFieldForPayouts(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrSumFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrSumFieldForPayouts($field, $idAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrSumFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrSumFieldForPayouts(field => $field, idAlpha => $idAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrSumFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_sum_field_for_payouts(field, idAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrSumFieldForPayouts: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrSumFieldForPayouts(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/sum/refundsandreversals/{field}/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/sum/refundsandreversals/{field}/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrSumFieldForRefsAndRevsWith:field
    idAlpha:idAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs(field, idAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrSumFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs($field, $idAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs(field => $field, idAlpha => $idAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves a graph of the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_sum_field_for_refs_and_revs(field, idAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrSumFieldForRefsAndRevs(field, idAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getPrtnOrMrchtGraphGrTxnsCount

This endpoint counts and creates a graph of the number of transactions for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/count/graph/{graphType}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/count/graph/{graphType}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.GraphApi;

import java.io.File;
import java.util.*;

public class GraphApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        GraphApi apiInstance = new GraphApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrTxnsCount");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.GraphApi;

public class GraphApiExample {
    public static void main(String[] args) {
        GraphApi apiInstance = new GraphApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        GraphType graphType = ; // GraphType | 
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
        
        try {
            GraphResult result = apiInstance.getPrtnOrMrchtGraphGrTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GraphApi#getPrtnOrMrchtGraphGrTxnsCount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
GraphApi *apiInstance = [[GraphApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
GraphType *graphType = ; //  (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

// This endpoint counts and creates a graph of the number of transactions for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGraphGrTxnsCountWith:idAlpha
    graphType:graphType
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(GraphResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.GraphApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var graphType = ; // {GraphType} 
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the transactions. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGraphGrTxnsCount(idAlpha, graphType, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGraphGrTxnsCountExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new GraphApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var graphType = new GraphType(); // GraphType |  (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional)  (default to null)

            try {
                // This endpoint counts and creates a graph of the number of transactions for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                GraphResult result = apiInstance.getPrtnOrMrchtGraphGrTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GraphApi.getPrtnOrMrchtGraphGrTxnsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GraphApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$graphType = ; // GraphType | 
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the transactions. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

try {
    $result = $api_instance->getPrtnOrMrchtGraphGrTxnsCount($idAlpha, $graphType, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GraphApi->getPrtnOrMrchtGraphGrTxnsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::GraphApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::GraphApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $graphType = ; # GraphType | 
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the transactions. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

eval { 
    my $result = $api_instance->getPrtnOrMrchtGraphGrTxnsCount(idAlpha => $idAlpha, graphType => $graphType, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GraphApi->getPrtnOrMrchtGraphGrTxnsCount: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.GraphApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
graphType =  # GraphType |  (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the transactions. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount) (optional) (default to null)

try: 
    # This endpoint counts and creates a graph of the number of transactions for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_graph_gr_txns_count(idAlpha, graphType, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GraphApi->getPrtnOrMrchtGraphGrTxnsCount: %s\n" % e)
extern crate GraphApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let graphType = ; // GraphType
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = GraphApi::Context::default();
    let result = client.getPrtnOrMrchtGraphGrTxnsCount(idAlpha, graphType, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

graphType *

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the transactions. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by the number of hits (totalCount)

Responses


Net Endpoints

getGrNetField

This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results can be grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/net/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/net/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.NetApi;

import java.io.File;
import java.util.*;

public class NetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            AggregateGroupedNetResult result = apiInstance.getGrNetField(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getGrNetField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.NetApi;

public class NetApiExample {
    public static void main(String[] args) {
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            AggregateGroupedNetResult result = apiInstance.getGrNetField(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getGrNetField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
NetApi *apiInstance = [[NetApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

// This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results can be grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGrNetFieldWith:field
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedNetResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.NetApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalNet
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrNetField(field, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrNetFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new NetApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional)  (default to null)

            try {
                // This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results can be grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                AggregateGroupedNetResult result = apiInstance.getGrNetField(field, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NetApi.getGrNetField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NetApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

try {
    $result = $api_instance->getGrNetField($field, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetApi->getGrNetField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::NetApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::NetApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

eval { 
    my $result = $api_instance->getGrNetField(field => $field, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetApi->getGrNetField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.NetApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

try: 
    # This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results can be grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_gr_net_field(field, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetApi->getGrNetField: %s\n" % e)
extern crate NetApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = NetApi::Context::default();
    let result = client.getGrNetField(field, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalNet

Responses


getMrchtGrNetFieldForAdmin

This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/net/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/net/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.NetApi;

import java.io.File;
import java.util.*;

public class NetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            AggregateGroupedNetResult result = apiInstance.getMrchtGrNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getMrchtGrNetFieldForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.NetApi;

public class NetApiExample {
    public static void main(String[] args) {
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            AggregateGroupedNetResult result = apiInstance.getMrchtGrNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getMrchtGrNetFieldForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
NetApi *apiInstance = [[NetApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

// This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrNetFieldForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedNetResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.NetApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalNet
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrNetFieldForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new NetApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional)  (default to null)

            try {
                // This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedNetResult result = apiInstance.getMrchtGrNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NetApi.getMrchtGrNetFieldForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NetApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

try {
    $result = $api_instance->getMrchtGrNetFieldForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetApi->getMrchtGrNetFieldForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::NetApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::NetApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

eval { 
    my $result = $api_instance->getMrchtGrNetFieldForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetApi->getMrchtGrNetFieldForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.NetApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

try: 
    # This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_net_field_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetApi->getMrchtGrNetFieldForAdmin: %s\n" % e)
extern crate NetApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = NetApi::Context::default();
    let result = client.getMrchtGrNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalNet

Responses


getMrchtNetFieldForAdmin

This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/net/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/net/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.NetApi;

import java.io.File;
import java.util.*;

public class NetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateNetResult result = apiInstance.getMrchtNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getMrchtNetFieldForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.NetApi;

public class NetApiExample {
    public static void main(String[] args) {
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateNetResult result = apiInstance.getMrchtNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getMrchtNetFieldForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
NetApi *apiInstance = [[NetApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtNetFieldForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateNetResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.NetApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtNetFieldForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new NetApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateNetResult result = apiInstance.getMrchtNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NetApi.getMrchtNetFieldForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NetApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtNetFieldForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetApi->getMrchtNetFieldForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::NetApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::NetApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtNetFieldForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetApi->getMrchtNetFieldForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.NetApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_net_field_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetApi->getMrchtNetFieldForAdmin: %s\n" % e)
extern crate NetApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = NetApi::Context::default();
    let result = client.getMrchtNetFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getNetField

This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals.
/transactions/aggregate/net/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/net/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.NetApi;

import java.io.File;
import java.util.*;

public class NetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateNetResult result = apiInstance.getNetField(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getNetField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.NetApi;

public class NetApiExample {
    public static void main(String[] args) {
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateNetResult result = apiInstance.getNetField(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getNetField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
NetApi *apiInstance = [[NetApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals.
[apiInstance getNetFieldWith:field
    requestConfig:requestConfig
              completionHandler: ^(AggregateNetResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.NetApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetField(field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getNetFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new NetApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals.
                AggregateNetResult result = apiInstance.getNetField(field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NetApi.getNetField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NetApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getNetField($field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetApi->getNetField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::NetApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::NetApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getNetField(field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetApi->getNetField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.NetApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the total net value of a specific field (for exammple the amount), the net value corresponds to the payouts - refunds&reversals.
    api_response = api_instance.get_net_field(field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetApi->getNetField: %s\n" % e)
extern crate NetApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = NetApi::Context::default();
    let result = client.getNetField(field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtGrNetField

This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/net/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/net/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.NetApi;

import java.io.File;
import java.util.*;

public class NetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            AggregateGroupedNetResult result = apiInstance.getPrtnOrMrchtGrNetField(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getPrtnOrMrchtGrNetField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.NetApi;

public class NetApiExample {
    public static void main(String[] args) {
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet
        
        try {
            AggregateGroupedNetResult result = apiInstance.getPrtnOrMrchtGrNetField(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getPrtnOrMrchtGrNetField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
NetApi *apiInstance = [[NetApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

// This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrNetFieldWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedNetResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.NetApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalNet
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrNetField(field, idAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrNetFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new NetApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional)  (default to null)

            try {
                // This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedNetResult result = apiInstance.getPrtnOrMrchtGrNetField(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NetApi.getPrtnOrMrchtGrNetField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NetApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

try {
    $result = $api_instance->getPrtnOrMrchtGrNetField($field, $idAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetApi->getPrtnOrMrchtGrNetField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::NetApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::NetApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrNetField(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetApi->getPrtnOrMrchtGrNetField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.NetApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalNet (optional) (default to null)

try: 
    # This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. Results are grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_net_field(field, idAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetApi->getPrtnOrMrchtGrNetField: %s\n" % e)
extern crate NetApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = NetApi::Context::default();
    let result = client.getPrtnOrMrchtGrNetField(field, idAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalNet

Responses


getPrtnOrMrchtNetField

This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/net/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/net/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.NetApi;

import java.io.File;
import java.util.*;

public class NetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateNetResult result = apiInstance.getPrtnOrMrchtNetField(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getPrtnOrMrchtNetField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.NetApi;

public class NetApiExample {
    public static void main(String[] args) {
        NetApi apiInstance = new NetApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateNetResult result = apiInstance.getPrtnOrMrchtNetField(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetApi#getPrtnOrMrchtNetField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
NetApi *apiInstance = [[NetApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtNetFieldWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateNetResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.NetApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtNetField(field, idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtNetFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new NetApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateNetResult result = apiInstance.getPrtnOrMrchtNetField(field, idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NetApi.getPrtnOrMrchtNetField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NetApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtNetField($field, $idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetApi->getPrtnOrMrchtNetField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::NetApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::NetApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtNetField(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetApi->getPrtnOrMrchtNetField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.NetApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint retrieves the total net value of a specific field (for exammple the amount) for a specific merchant/partner, the net value corresponds to the payouts - refunds&reversals. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_net_field(field, idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetApi->getPrtnOrMrchtNetField: %s\n" % e)
extern crate NetApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = NetApi::Context::default();
    let result = client.getPrtnOrMrchtNetField(field, idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


Sum Endpoints

getGrSumField

This endpoint sums up the values of a specific field (for example the amount) and groups the results by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/sum/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/sum/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getGrSumField(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getGrSumField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getGrSumField(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getGrSumField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint sums up the values of a specific field (for example the amount) and groups the results by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGrSumFieldWith:field
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrSumField(field, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrSumFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint sums up the values of a specific field (for example the amount) and groups the results by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                AggregateGroupedSumResult result = apiInstance.getGrSumField(field, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getGrSumField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getGrSumField($field, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getGrSumField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getGrSumField(field => $field, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getGrSumField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint sums up the values of a specific field (for example the amount) and groups the results by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_gr_sum_field(field, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getGrSumField: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = SumApi::Context::default();
    let result = client.getGrSumField(field, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getGrSumFieldForPayouts

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/sum/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/sum/payouts/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getGrSumFieldForPayouts(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getGrSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getGrSumFieldForPayouts(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getGrSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGrSumFieldForPayoutsWith:field
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrSumFieldForPayouts(field, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrSumFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                AggregateGroupedSumResult result = apiInstance.getGrSumFieldForPayouts(field, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getGrSumFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getGrSumFieldForPayouts($field, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getGrSumFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getGrSumFieldForPayouts(field => $field, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getGrSumFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_gr_sum_field_for_payouts(field, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getGrSumFieldForPayouts: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = SumApi::Context::default();
    let result = client.getGrSumFieldForPayouts(field, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getGrSumFieldForRefsAndRevs

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
/transactions/aggregate/group/sum/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/group/sum/refundsandreversals/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getGrSumFieldForRefsAndRevs(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getGrSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getGrSumFieldForRefsAndRevs(field, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getGrSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
[apiInstance getGrSumFieldForRefsAndRevsWith:field
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGrSumFieldForRefsAndRevs(field, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getGrSumFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
                AggregateGroupedSumResult result = apiInstance.getGrSumFieldForRefsAndRevs(field, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getGrSumFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getGrSumFieldForRefsAndRevs($field, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getGrSumFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getGrSumFieldForRefsAndRevs(field => $field, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getGrSumFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC').
    api_response = api_instance.get_gr_sum_field_for_refs_and_revs(field, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getGrSumFieldForRefsAndRevs: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = SumApi::Context::default();
    let result = client.getGrSumFieldForRefsAndRevs(field, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getMrchtGrSumFieldForAdmin

This endpoint sums up the values of a field (for example the amount) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getMrchtGrSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtGrSumFieldForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getMrchtGrSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtGrSumFieldForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint sums up the values of a field (for example the amount) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrSumFieldForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrSumFieldForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint sums up the values of a field (for example the amount) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedSumResult result = apiInstance.getMrchtGrSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getMrchtGrSumFieldForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getMrchtGrSumFieldForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getMrchtGrSumFieldForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getMrchtGrSumFieldForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getMrchtGrSumFieldForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint sums up the values of a field (for example the amount) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_sum_field_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getMrchtGrSumFieldForAdmin: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = SumApi::Context::default();
    let result = client.getMrchtGrSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getMrchtGrSumFieldForPayoutsForAdmin

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/payouts/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getMrchtGrSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtGrSumFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getMrchtGrSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtGrSumFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrSumFieldForPayoutsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrSumFieldForPayoutsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedSumResult result = apiInstance.getMrchtGrSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getMrchtGrSumFieldForPayoutsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getMrchtGrSumFieldForPayoutsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getMrchtGrSumFieldForPayoutsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getMrchtGrSumFieldForPayoutsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getMrchtGrSumFieldForPayoutsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_sum_field_for_payouts_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getMrchtGrSumFieldForPayoutsForAdmin: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = SumApi::Context::default();
    let result = client.getMrchtGrSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getMrchtGrSumFieldForRefsAndRevsForAdmin

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/group/sum/refundsandreversals/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getMrchtGrSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtGrSumFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getMrchtGrSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtGrSumFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtGrSumFieldForRefsAndRevsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtGrSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtGrSumFieldForRefsAndRevsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedSumResult result = apiInstance.getMrchtGrSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getMrchtGrSumFieldForRefsAndRevsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getMrchtGrSumFieldForRefsAndRevsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getMrchtGrSumFieldForRefsAndRevsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getMrchtGrSumFieldForRefsAndRevsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getMrchtGrSumFieldForRefsAndRevsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_gr_sum_field_for_refs_and_revs_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getMrchtGrSumFieldForRefsAndRevsForAdmin: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = SumApi::Context::default();
    let result = client.getMrchtGrSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getMrchtSumFieldForAdmin

This endpoint sums up the values of a field (for example the amount). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/sum/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/sum/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getMrchtSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtSumFieldForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getMrchtSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtSumFieldForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint sums up the values of a field (for example the amount). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtSumFieldForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtSumFieldForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint sums up the values of a field (for example the amount). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateSumResult result = apiInstance.getMrchtSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getMrchtSumFieldForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtSumFieldForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getMrchtSumFieldForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtSumFieldForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getMrchtSumFieldForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint sums up the values of a field (for example the amount). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_sum_field_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getMrchtSumFieldForAdmin: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = SumApi::Context::default();
    let result = client.getMrchtSumFieldForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtSumFieldForPayoutsForAdmin

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/sum/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/sum/payouts/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getMrchtSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtSumFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getMrchtSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtSumFieldForPayoutsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtSumFieldForPayoutsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtSumFieldForPayoutsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateSumResult result = apiInstance.getMrchtSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getMrchtSumFieldForPayoutsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtSumFieldForPayoutsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getMrchtSumFieldForPayoutsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtSumFieldForPayoutsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getMrchtSumFieldForPayoutsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_sum_field_for_payouts_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getMrchtSumFieldForPayoutsForAdmin: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = SumApi::Context::default();
    let result = client.getMrchtSumFieldForPayoutsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtSumFieldForRefsAndRevsForAdmin

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/sum/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/aggregate/sum/refundsandreversals/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getMrchtSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtSumFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getMrchtSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getMrchtSumFieldForRefsAndRevsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtSumFieldForRefsAndRevsForAdminWith:field
    merchantIdAlpha:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtSumFieldForRefsAndRevsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateSumResult result = apiInstance.getMrchtSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getMrchtSumFieldForRefsAndRevsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtSumFieldForRefsAndRevsForAdmin($field, $merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getMrchtSumFieldForRefsAndRevsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtSumFieldForRefsAndRevsForAdmin(field => $field, merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getMrchtSumFieldForRefsAndRevsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_sum_field_for_refs_and_revs_for_admin(field, merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getMrchtSumFieldForRefsAndRevsForAdmin: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = SumApi::Context::default();
    let result = client.getMrchtSumFieldForRefsAndRevsForAdmin(field, merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtGrSumField

This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/sum/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/sum/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getPrtnOrMrchtGrSumField(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtGrSumField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getPrtnOrMrchtGrSumField(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtGrSumField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrSumFieldWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrSumField(field, idAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrSumFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedSumResult result = apiInstance.getPrtnOrMrchtGrSumField(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getPrtnOrMrchtGrSumField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getPrtnOrMrchtGrSumField($field, $idAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getPrtnOrMrchtGrSumField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrSumField(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getPrtnOrMrchtGrSumField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_sum_field(field, idAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getPrtnOrMrchtGrSumField: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = SumApi::Context::default();
    let result = client.getPrtnOrMrchtGrSumField(field, idAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getPrtnOrMrchtGrSumFieldForPayouts

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/sum/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/sum/payouts/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getPrtnOrMrchtGrSumFieldForPayouts(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtGrSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getPrtnOrMrchtGrSumFieldForPayouts(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtGrSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrSumFieldForPayoutsWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrSumFieldForPayouts(field, idAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrSumFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedSumResult result = apiInstance.getPrtnOrMrchtGrSumFieldForPayouts(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getPrtnOrMrchtGrSumFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getPrtnOrMrchtGrSumFieldForPayouts($field, $idAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getPrtnOrMrchtGrSumFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrSumFieldForPayouts(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getPrtnOrMrchtGrSumFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_sum_field_for_payouts(field, idAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getPrtnOrMrchtGrSumFieldForPayouts: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = SumApi::Context::default();
    let result = client.getPrtnOrMrchtGrSumFieldForPayouts(field, idAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getPrtnOrMrchtGrSumFieldForRefsAndRevs

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/group/sum/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/group/sum/refundsandreversals/{field}?groupBy=&calendarInterval=&order="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getPrtnOrMrchtGrSumFieldForRefsAndRevs(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtGrSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        String groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
        CalendarInterval calendarInterval = ; // CalendarInterval | 
        Order order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum
        
        try {
            AggregateGroupedSumResult result = apiInstance.getPrtnOrMrchtGrSumFieldForRefsAndRevs(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtGrSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 
String *groupBy = groupBy_example; // List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
CalendarInterval *calendarInterval = ; //  (optional) (default to null)
Order *order = ; // Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtGrSumFieldForRefsAndRevsWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
    groupBy:groupBy
    calendarInterval:calendarInterval
    order:order
              completionHandler: ^(AggregateGroupedSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 
var opts = {
  'groupBy': groupBy_example, // {String} List of fields used to group the query. Ex: serial number,card type etc.
  'calendarInterval': , // {CalendarInterval} 
  'order':  // {Order} Enum [ASC/DESC] used to order the aggregated data by totalSum
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtGrSumFieldForRefsAndRevs(field, idAlpha, requestConfig, opts, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtGrSumFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 
            var groupBy = groupBy_example;  // String | List of fields used to group the query. Ex: serial number,card type etc. (optional)  (default to null)
            var calendarInterval = new CalendarInterval(); // CalendarInterval |  (optional)  (default to null)
            var order = new Order(); // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional)  (default to null)

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateGroupedSumResult result = apiInstance.getPrtnOrMrchtGrSumFieldForRefsAndRevs(field, idAlpha, requestConfig, groupBy, calendarInterval, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getPrtnOrMrchtGrSumFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 
$groupBy = groupBy_example; // String | List of fields used to group the query. Ex: serial number,card type etc.
$calendarInterval = ; // CalendarInterval | 
$order = ; // Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

try {
    $result = $api_instance->getPrtnOrMrchtGrSumFieldForRefsAndRevs($field, $idAlpha, $requestConfig, $groupBy, $calendarInterval, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getPrtnOrMrchtGrSumFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 
my $groupBy = groupBy_example; # String | List of fields used to group the query. Ex: serial number,card type etc.
my $calendarInterval = ; # CalendarInterval | 
my $order = ; # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum

eval { 
    my $result = $api_instance->getPrtnOrMrchtGrSumFieldForRefsAndRevs(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig, groupBy => $groupBy, calendarInterval => $calendarInterval, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getPrtnOrMrchtGrSumFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 
groupBy = groupBy_example # String | List of fields used to group the query. Ex: serial number,card type etc. (optional) (default to null)
calendarInterval =  # CalendarInterval |  (optional) (default to null)
order =  # Order | Enum [ASC/DESC] used to order the aggregated data by totalSum (optional) (default to null)

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant and serves the results grouped by a set of query parameters ('groupBy', 'calendarInterval' or 'ASC/DESC'). 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_gr_sum_field_for_refs_and_revs(field, idAlpha, requestConfig, groupBy=groupBy, calendarInterval=calendarInterval, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getPrtnOrMrchtGrSumFieldForRefsAndRevs: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig
    let groupBy = groupBy_example; // String
    let calendarInterval = ; // CalendarInterval
    let order = ; // Order

    let mut context = SumApi::Context::default();
    let result = client.getPrtnOrMrchtGrSumFieldForRefsAndRevs(field, idAlpha, requestConfig, groupBy, calendarInterval, order, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Query parameters
Name Description
groupBy

List of fields used to group the query. Ex: serial number,card type etc.

calendarInterval

order

Enum [ASC/DESC] used to order the aggregated data by totalSum

Responses


getPrtnOrMrchtSumField

This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/sum/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/sum/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getPrtnOrMrchtSumField(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtSumField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getPrtnOrMrchtSumField(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtSumField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtSumFieldWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtSumField(field, idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtSumFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateSumResult result = apiInstance.getPrtnOrMrchtSumField(field, idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getPrtnOrMrchtSumField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtSumField($field, $idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getPrtnOrMrchtSumField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtSumField(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getPrtnOrMrchtSumField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint sums up the values of a field (for example the amount) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_sum_field(field, idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getPrtnOrMrchtSumField: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = SumApi::Context::default();
    let result = client.getPrtnOrMrchtSumField(field, idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtSumFieldForPayouts

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/sum/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/sum/payouts/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getPrtnOrMrchtSumFieldForPayouts(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getPrtnOrMrchtSumFieldForPayouts(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtSumFieldForPayoutsWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtSumFieldForPayouts(field, idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtSumFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateSumResult result = apiInstance.getPrtnOrMrchtSumFieldForPayouts(field, idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getPrtnOrMrchtSumFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtSumFieldForPayouts($field, $idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getPrtnOrMrchtSumFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtSumFieldForPayouts(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getPrtnOrMrchtSumFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_sum_field_for_payouts(field, idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getPrtnOrMrchtSumFieldForPayouts: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = SumApi::Context::default();
    let result = client.getPrtnOrMrchtSumFieldForPayouts(field, idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtSumFieldForRefsAndRevs

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/aggregate/sum/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/aggregate/sum/refundsandreversals/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getPrtnOrMrchtSumFieldForRefsAndRevs(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getPrtnOrMrchtSumFieldForRefsAndRevs(field, idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getPrtnOrMrchtSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtSumFieldForRefsAndRevsWith:field
    idAlpha:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(AggregateSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtSumFieldForRefsAndRevs(field, idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtSumFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                AggregateSumResult result = apiInstance.getPrtnOrMrchtSumFieldForRefsAndRevs(field, idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getPrtnOrMrchtSumFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtSumFieldForRefsAndRevs($field, $idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getPrtnOrMrchtSumFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtSumFieldForRefsAndRevs(field => $field, idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getPrtnOrMrchtSumFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_sum_field_for_refs_and_revs(field, idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getPrtnOrMrchtSumFieldForRefsAndRevs: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = SumApi::Context::default();
    let result = client.getPrtnOrMrchtSumFieldForRefsAndRevs(field, idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getSumField

This endpoint sums up the values of a specific field (for example the amount).
/transactions/aggregate/sum/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/sum/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getSumField(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getSumField");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getSumField(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getSumField");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint sums up the values of a specific field (for example the amount).
[apiInstance getSumFieldWith:field
    requestConfig:requestConfig
              completionHandler: ^(AggregateSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSumField(field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getSumFieldExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint sums up the values of a specific field (for example the amount).
                AggregateSumResult result = apiInstance.getSumField(field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getSumField: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getSumField($field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getSumField: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getSumField(field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getSumField: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint sums up the values of a specific field (for example the amount).
    api_response = api_instance.get_sum_field(field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getSumField: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = SumApi::Context::default();
    let result = client.getSumField(field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getSumFieldForPayouts

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
/transactions/aggregate/sum/payouts/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/sum/payouts/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getSumFieldForPayouts(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getSumFieldForPayouts(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getSumFieldForPayouts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
[apiInstance getSumFieldForPayoutsWith:field
    requestConfig:requestConfig
              completionHandler: ^(AggregateSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSumFieldForPayouts(field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getSumFieldForPayoutsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
                AggregateSumResult result = apiInstance.getSumFieldForPayouts(field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getSumFieldForPayouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getSumFieldForPayouts($field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getSumFieldForPayouts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getSumFieldForPayouts(field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getSumFieldForPayouts: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
    api_response = api_instance.get_sum_field_for_payouts(field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getSumFieldForPayouts: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = SumApi::Context::default();
    let result = client.getSumFieldForPayouts(field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


getSumFieldForRefsAndRevs

This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
/transactions/aggregate/sum/refundsandreversals/{field}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/aggregate/sum/refundsandreversals/{field}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.SumApi;

import java.io.File;
import java.util.*;

public class SumApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getSumFieldForRefsAndRevs(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.SumApi;

public class SumApiExample {
    public static void main(String[] args) {
        SumApi apiInstance = new SumApi();
        String field = field_example; // String | Field to be targeted for the aggregation
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            AggregateSumResult result = apiInstance.getSumFieldForRefsAndRevs(field, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SumApi#getSumFieldForRefsAndRevs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
SumApi *apiInstance = [[SumApi alloc] init];
String *field = field_example; // Field to be targeted for the aggregation (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
[apiInstance getSumFieldForRefsAndRevsWith:field
    requestConfig:requestConfig
              completionHandler: ^(AggregateSumResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.SumApi()
var field = field_example; // {String} Field to be targeted for the aggregation
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSumFieldForRefsAndRevs(field, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getSumFieldForRefsAndRevsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new SumApi();
            var field = field_example;  // String | Field to be targeted for the aggregation (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
                AggregateSumResult result = apiInstance.getSumFieldForRefsAndRevs(field, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SumApi.getSumFieldForRefsAndRevs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SumApi();
$field = field_example; // String | Field to be targeted for the aggregation
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getSumFieldForRefsAndRevs($field, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SumApi->getSumFieldForRefsAndRevs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::SumApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::SumApi->new();
my $field = field_example; # String | Field to be targeted for the aggregation
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getSumFieldForRefsAndRevs(field => $field, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SumApi->getSumFieldForRefsAndRevs: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.SumApi()
field = field_example # String | Field to be targeted for the aggregation (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint calculates the sum of a specific field (i.e the amount) for all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
    api_response = api_instance.get_sum_field_for_refs_and_revs(field, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SumApi->getSumFieldForRefsAndRevs: %s\n" % e)
extern crate SumApi;

pub fn main() {
    let field = field_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = SumApi::Context::default();
    let result = client.getSumFieldForRefsAndRevs(field, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
field *

Field to be targeted for the aggregation

Body parameters
Name Description
requestConfig *

Request filters

Responses


Transactions Endpoints

getMrchtPayoutsTxnsForAdmin

This endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/payouts

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/payouts"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getMrchtPayoutsTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getMrchtPayoutsTxnsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getMrchtPayoutsTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getMrchtPayoutsTxnsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtPayoutsTxnsForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtPayoutsTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtPayoutsTxnsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                TransactionDetailsResult result = apiInstance.getMrchtPayoutsTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getMrchtPayoutsTxnsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtPayoutsTxnsForAdmin($merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getMrchtPayoutsTxnsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtPayoutsTxnsForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getMrchtPayoutsTxnsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_payouts_txns_for_admin(merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getMrchtPayoutsTxnsForAdmin: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = TransactionsApi::Context::default();
    let result = client.getMrchtPayoutsTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtRefsAndRevsTxnsForAdmin

The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{partner_id_alpha}/{merchant_id_alpha}/refundsandreversals

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}/refundsandreversals"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getMrchtRefsAndRevsTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getMrchtRefsAndRevsTxnsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getMrchtRefsAndRevsTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getMrchtRefsAndRevsTxnsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getMrchtRefsAndRevsTxnsForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtRefsAndRevsTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtRefsAndRevsTxnsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                TransactionDetailsResult result = apiInstance.getMrchtRefsAndRevsTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getMrchtRefsAndRevsTxnsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtRefsAndRevsTxnsForAdmin($merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getMrchtRefsAndRevsTxnsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtRefsAndRevsTxnsForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getMrchtRefsAndRevsTxnsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal). 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_mrcht_refs_and_revs_txns_for_admin(merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getMrchtRefsAndRevsTxnsForAdmin: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = TransactionsApi::Context::default();
    let result = client.getMrchtRefsAndRevsTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getMrchtTxnsForAdmin

This endpoint returns the transactions of a merchant. 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS). 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
/transactions/{partner_id_alpha}/{merchant_id_alpha}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{partner_id_alpha}/{merchant_id_alpha}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getMrchtTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getMrchtTxnsForAdmin");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
        String partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getMrchtTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getMrchtTxnsForAdmin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
String *merchantIdAlpha = merchantIdAlpha_example; // The id of the merchant (default to null)
String *partnerIdAlpha = partnerIdAlpha_example; // The id of the partner (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint returns the transactions of a merchant. 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS). 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
[apiInstance getMrchtTxnsForAdminWith:merchantIdAlpha
    partnerIdAlpha:partnerIdAlpha
    requestConfig:requestConfig
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var merchantIdAlpha = merchantIdAlpha_example; // {String} The id of the merchant
var partnerIdAlpha = partnerIdAlpha_example; // {String} The id of the partner
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMrchtTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getMrchtTxnsForAdminExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var merchantIdAlpha = merchantIdAlpha_example;  // String | The id of the merchant (default to null)
            var partnerIdAlpha = partnerIdAlpha_example;  // String | The id of the partner (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint returns the transactions of a merchant. 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS). 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
                TransactionDetailsResult result = apiInstance.getMrchtTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getMrchtTxnsForAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$merchantIdAlpha = merchantIdAlpha_example; // String | The id of the merchant
$partnerIdAlpha = partnerIdAlpha_example; // String | The id of the partner
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getMrchtTxnsForAdmin($merchantIdAlpha, $partnerIdAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getMrchtTxnsForAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $merchantIdAlpha = merchantIdAlpha_example; # String | The id of the merchant
my $partnerIdAlpha = partnerIdAlpha_example; # String | The id of the partner
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getMrchtTxnsForAdmin(merchantIdAlpha => $merchantIdAlpha, partnerIdAlpha => $partnerIdAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getMrchtTxnsForAdmin: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
merchantIdAlpha = merchantIdAlpha_example # String | The id of the merchant (default to null)
partnerIdAlpha = partnerIdAlpha_example # String | The id of the partner (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint returns the transactions of a merchant. 
 The {partner_id_alpha} and {merchant_id_alpha} are unique id's assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS). 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
    api_response = api_instance.get_mrcht_txns_for_admin(merchantIdAlpha, partnerIdAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getMrchtTxnsForAdmin: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let merchantIdAlpha = merchantIdAlpha_example; // String
    let partnerIdAlpha = partnerIdAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = TransactionsApi::Context::default();
    let result = client.getMrchtTxnsForAdmin(merchantIdAlpha, partnerIdAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
merchantIdAlpha *

The id of the merchant

partnerIdAlpha *

The id of the partner

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPayoutsTxns

The payouts endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
/transactions/payouts

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/payouts"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getPayoutsTxns(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getPayoutsTxns");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getPayoutsTxns(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getPayoutsTxns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
RequestConfig *requestConfig = ; // 

// The payouts endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
[apiInstance getPayoutsTxnsWith:requestConfig
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPayoutsTxns(requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPayoutsTxnsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // The payouts endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
                TransactionDetailsResult result = apiInstance.getPayoutsTxns(requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getPayoutsTxns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPayoutsTxns($requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getPayoutsTxns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPayoutsTxns(requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getPayoutsTxns: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
requestConfig =  # RequestConfig | 

try: 
    # The payouts endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture).
    api_response = api_instance.get_payouts_txns(requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getPayoutsTxns: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let requestConfig = ; // RequestConfig

    let mut context = TransactionsApi::Context::default();
    let result = client.getPayoutsTxns(requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtPayoutsTxns

This endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/payouts

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/payouts"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getPrtnOrMrchtPayoutsTxns(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getPrtnOrMrchtPayoutsTxns");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getPrtnOrMrchtPayoutsTxns(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getPrtnOrMrchtPayoutsTxns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtPayoutsTxnsWith:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtPayoutsTxns(idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtPayoutsTxnsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                TransactionDetailsResult result = apiInstance.getPrtnOrMrchtPayoutsTxns(idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getPrtnOrMrchtPayoutsTxns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtPayoutsTxns($idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getPrtnOrMrchtPayoutsTxns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtPayoutsTxns(idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getPrtnOrMrchtPayoutsTxns: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint returns all transactions representing an income of cash flow (EMV Sale, MSR Sale, Refund Reversal, Refund Cancellation and Pre-authorization Capture) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_payouts_txns(idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getPrtnOrMrchtPayoutsTxns: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = TransactionsApi::Context::default();
    let result = client.getPrtnOrMrchtPayoutsTxns(idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtRefsAndRevsTxns

The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
/transactions/{id_alpha}/refundsandreversals

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}/refundsandreversals"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getPrtnOrMrchtRefsAndRevsTxns(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getPrtnOrMrchtRefsAndRevsTxns");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getPrtnOrMrchtRefsAndRevsTxns(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getPrtnOrMrchtRefsAndRevsTxns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
[apiInstance getPrtnOrMrchtRefsAndRevsTxnsWith:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtRefsAndRevsTxns(idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtRefsAndRevsTxnsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
                TransactionDetailsResult result = apiInstance.getPrtnOrMrchtRefsAndRevsTxns(idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getPrtnOrMrchtRefsAndRevsTxns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtRefsAndRevsTxns($idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getPrtnOrMrchtRefsAndRevsTxns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtRefsAndRevsTxns(idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getPrtnOrMrchtRefsAndRevsTxns: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal) for a specific partner/merchant using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS).
    api_response = api_instance.get_prtn_or_mrcht_refs_and_revs_txns(idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getPrtnOrMrchtRefsAndRevsTxns: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = TransactionsApi::Context::default();
    let result = client.getPrtnOrMrchtRefsAndRevsTxns(idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getPrtnOrMrchtTxns

This endpoint allows developers to retrieve the transactions of a specific merchant or partner using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS). 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
/transactions/{id_alpha}

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/{id_alpha}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getPrtnOrMrchtTxns(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getPrtnOrMrchtTxns");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String idAlpha = idAlpha_example; // String | The id of the target partner/merchant
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getPrtnOrMrchtTxns(idAlpha, requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getPrtnOrMrchtTxns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
String *idAlpha = idAlpha_example; // The id of the target partner/merchant (default to null)
RequestConfig *requestConfig = ; // 

// This endpoint allows developers to retrieve the transactions of a specific merchant or partner using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS). 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
[apiInstance getPrtnOrMrchtTxnsWith:idAlpha
    requestConfig:requestConfig
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var idAlpha = idAlpha_example; // {String} The id of the target partner/merchant
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrtnOrMrchtTxns(idAlpha, requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getPrtnOrMrchtTxnsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var idAlpha = idAlpha_example;  // String | The id of the target partner/merchant (default to null)
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This endpoint allows developers to retrieve the transactions of a specific merchant or partner using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS). 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
                TransactionDetailsResult result = apiInstance.getPrtnOrMrchtTxns(idAlpha, requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getPrtnOrMrchtTxns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$idAlpha = idAlpha_example; // String | The id of the target partner/merchant
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getPrtnOrMrchtTxns($idAlpha, $requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getPrtnOrMrchtTxns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $idAlpha = idAlpha_example; # String | The id of the target partner/merchant
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getPrtnOrMrchtTxns(idAlpha => $idAlpha, requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getPrtnOrMrchtTxns: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
idAlpha = idAlpha_example # String | The id of the target partner/merchant (default to null)
requestConfig =  # RequestConfig | 

try: 
    # This endpoint allows developers to retrieve the transactions of a specific merchant or partner using their unique {id_alpha}. 
 The {id_alpha} can either be the {merchant_id_alpha} or the {partner_id_alpha}. 
 The {id_alpha} is a unique id assigned to each partner and each merchant in the Handpoint Terminal Management System (TMS). 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
    api_response = api_instance.get_prtn_or_mrcht_txns(idAlpha, requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getPrtnOrMrchtTxns: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let idAlpha = idAlpha_example; // String
    let requestConfig = ; // RequestConfig

    let mut context = TransactionsApi::Context::default();
    let result = client.getPrtnOrMrchtTxns(idAlpha, requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
idAlpha *

The id of the target partner/merchant

Body parameters
Name Description
requestConfig *

Request filters

Responses


getRefsAndRevsTxns

The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
/transactions/refundsandreversals

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions/refundsandreversals"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getRefsAndRevsTxns(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getRefsAndRevsTxns");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getRefsAndRevsTxns(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getRefsAndRevsTxns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
RequestConfig *requestConfig = ; // 

// The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
[apiInstance getRefsAndRevsTxnsWith:requestConfig
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRefsAndRevsTxns(requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getRefsAndRevsTxnsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
                TransactionDetailsResult result = apiInstance.getRefsAndRevsTxns(requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getRefsAndRevsTxns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getRefsAndRevsTxns($requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getRefsAndRevsTxns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getRefsAndRevsTxns(requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getRefsAndRevsTxns: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
requestConfig =  # RequestConfig | 

try: 
    # The refunds and reversals endpoint returns all transactions representing an outgoing of cash flow (EMV Refund, MSR Refund, Sale Reversal, Sale Cancellation and Pre-authorization Capture Reversal).
    api_response = api_instance.get_refs_and_revs_txns(requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getRefsAndRevsTxns: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let requestConfig = ; // RequestConfig

    let mut context = TransactionsApi::Context::default();
    let result = client.getRefsAndRevsTxns(requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Body parameters
Name Description
requestConfig *

Request filters

Responses


getTxnByCustomerReference

This endpoint retrieves the details of a specific group of transactions based on their customer references. The customer Reference is not guaranteed to be unique since this value is defined by the developer integrating against the Handpoint SDKs/APIs, the customerReference is passed as a parameter in the transaction when processing a payment, for that reason the result returned is an array of transactions.
/transactions/customer-reference/{customerReference}

Usage and SDK Samples

curl -X GET \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
 \
"https://txnfeed.handpoint.com/transactions/customer-reference/{customerReference}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        String customerReference = customerReference_example; // String | customerReference of the transaction (the customerReference is originally passed in the transaction request by the developer when processing a payment)
        
        try {
            TransactionDetailsResult result = apiInstance.getTxnByCustomerReference(customerReference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTxnByCustomerReference");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String customerReference = customerReference_example; // String | customerReference of the transaction (the customerReference is originally passed in the transaction request by the developer when processing a payment)
        
        try {
            TransactionDetailsResult result = apiInstance.getTxnByCustomerReference(customerReference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTxnByCustomerReference");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
String *customerReference = customerReference_example; // customerReference of the transaction (the customerReference is originally passed in the transaction request by the developer when processing a payment) (default to null)

// This endpoint retrieves the details of a specific group of transactions based on their customer references. The customer Reference is not guaranteed to be unique since this value is defined by the developer integrating against the Handpoint SDKs/APIs, the customerReference is passed as a parameter in the transaction when processing a payment, for that reason the result returned is an array of transactions.
[apiInstance getTxnByCustomerReferenceWith:customerReference
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var customerReference = customerReference_example; // {String} customerReference of the transaction (the customerReference is originally passed in the transaction request by the developer when processing a payment)

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTxnByCustomerReference(customerReference, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getTxnByCustomerReferenceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var customerReference = customerReference_example;  // String | customerReference of the transaction (the customerReference is originally passed in the transaction request by the developer when processing a payment) (default to null)

            try {
                // This endpoint retrieves the details of a specific group of transactions based on their customer references. The customer Reference is not guaranteed to be unique since this value is defined by the developer integrating against the Handpoint SDKs/APIs, the customerReference is passed as a parameter in the transaction when processing a payment, for that reason the result returned is an array of transactions.
                TransactionDetailsResult result = apiInstance.getTxnByCustomerReference(customerReference);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getTxnByCustomerReference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$customerReference = customerReference_example; // String | customerReference of the transaction (the customerReference is originally passed in the transaction request by the developer when processing a payment)

try {
    $result = $api_instance->getTxnByCustomerReference($customerReference);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getTxnByCustomerReference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $customerReference = customerReference_example; # String | customerReference of the transaction (the customerReference is originally passed in the transaction request by the developer when processing a payment)

eval { 
    my $result = $api_instance->getTxnByCustomerReference(customerReference => $customerReference);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getTxnByCustomerReference: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
customerReference = customerReference_example # String | customerReference of the transaction (the customerReference is originally passed in the transaction request by the developer when processing a payment) (default to null)

try: 
    # This endpoint retrieves the details of a specific group of transactions based on their customer references. The customer Reference is not guaranteed to be unique since this value is defined by the developer integrating against the Handpoint SDKs/APIs, the customerReference is passed as a parameter in the transaction when processing a payment, for that reason the result returned is an array of transactions.
    api_response = api_instance.get_txn_by_customer_reference(customerReference)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getTxnByCustomerReference: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let customerReference = customerReference_example; // String

    let mut context = TransactionsApi::Context::default();
    let result = client.getTxnByCustomerReference(customerReference, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
customerReference *

customerReference of the transaction (the customerReference is originally passed in the transaction request by the developer when processing a payment)

Responses


getTxnByGuid

This endpoint retrieves the details of a specific transaction based on its GUID.
/transactions/{guid}

Usage and SDK Samples

curl -X GET \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
 \
"https://txnfeed.handpoint.com/transactions/{guid}"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        String guid = guid_example; // String | Transaction GUID
        
        try {
            TransactionData result = apiInstance.getTxnByGuid(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTxnByGuid");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String guid = guid_example; // String | Transaction GUID
        
        try {
            TransactionData result = apiInstance.getTxnByGuid(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTxnByGuid");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
String *guid = guid_example; // Transaction GUID (default to null)

// This endpoint retrieves the details of a specific transaction based on its GUID.
[apiInstance getTxnByGuidWith:guid
              completionHandler: ^(TransactionData output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var guid = guid_example; // {String} Transaction GUID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTxnByGuid(guid, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getTxnByGuidExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var guid = guid_example;  // String | Transaction GUID (default to null)

            try {
                // This endpoint retrieves the details of a specific transaction based on its GUID.
                TransactionData result = apiInstance.getTxnByGuid(guid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getTxnByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$guid = guid_example; // String | Transaction GUID

try {
    $result = $api_instance->getTxnByGuid($guid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getTxnByGuid: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $guid = guid_example; # String | Transaction GUID

eval { 
    my $result = $api_instance->getTxnByGuid(guid => $guid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getTxnByGuid: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
guid = guid_example # String | Transaction GUID (default to null)

try: 
    # This endpoint retrieves the details of a specific transaction based on its GUID.
    api_response = api_instance.get_txn_by_guid(guid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getTxnByGuid: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = TransactionsApi::Context::default();
    let result = client.getTxnByGuid(guid, &context).wait();

    println!("{:?}", result);
}

Parameters

Path parameters
Name Description
guid *

Transaction GUID

Responses


getTxns

This is the main endpoint to retrieve transactions. In its simplest form the request body only needs to contain a timeframe. 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
/transactions

Usage and SDK Samples

curl -X POST \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "startDate":"20200101000000", "endDate": "20200201000000" }'  \
"https://txnfeed.handpoint.com/transactions"
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getTxns(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTxns");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        RequestConfig requestConfig = ; // RequestConfig | 
        
        try {
            TransactionDetailsResult result = apiInstance.getTxns(requestConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTxns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
RequestConfig *requestConfig = ; // 

// This is the main endpoint to retrieve transactions. In its simplest form the request body only needs to contain a timeframe. 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
[apiInstance getTxnsWith:requestConfig
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var requestConfig = ; // {RequestConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTxns(requestConfig, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getTxnsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var requestConfig = new RequestConfig(); // RequestConfig | 

            try {
                // This is the main endpoint to retrieve transactions. In its simplest form the request body only needs to contain a timeframe. 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
                TransactionDetailsResult result = apiInstance.getTxns(requestConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getTxns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$requestConfig = ; // RequestConfig | 

try {
    $result = $api_instance->getTxns($requestConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getTxns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $requestConfig = Com::Handpoint::Api::Txnfeed::Object::RequestConfig->new(); # RequestConfig | 

eval { 
    my $result = $api_instance->getTxns(requestConfig => $requestConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getTxns: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
requestConfig =  # RequestConfig | 

try: 
    # This is the main endpoint to retrieve transactions. In its simplest form the request body only needs to contain a timeframe. 
 Max batch size per request: 10000 records. Use initPosition in request body for paging data.
    api_response = api_instance.get_txns(requestConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getTxns: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let requestConfig = ; // RequestConfig

    let mut context = TransactionsApi::Context::default();
    let result = client.getTxns(requestConfig, &context).wait();

    println!("{:?}", result);
}

Parameters

Body parameters
Name Description
requestConfig *

Request filters

Responses


getTxnsByCustomerReference

This endpoint retrieves the details of a specific group of transactions based on a list of customer references.
/transactions/customer-references

Usage and SDK Samples

curl -X GET \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
 \
"https://txnfeed.handpoint.com/transactions/customer-references?listOfCustomerReferences="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        String listOfCustomerReferences = listOfCustomerReferences_example; // String | List of customerReference for the transactions to be retrieved (comma separated string) Ex: 'ref01,ref02,ref03' (the customerReference is originally passed in the transaction request by the developer when processing a payment)
        
        try {
            TransactionDetailsResult result = apiInstance.getTxnsByCustomerReference(listOfCustomerReferences);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTxnsByCustomerReference");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String listOfCustomerReferences = listOfCustomerReferences_example; // String | List of customerReference for the transactions to be retrieved (comma separated string) Ex: 'ref01,ref02,ref03' (the customerReference is originally passed in the transaction request by the developer when processing a payment)
        
        try {
            TransactionDetailsResult result = apiInstance.getTxnsByCustomerReference(listOfCustomerReferences);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTxnsByCustomerReference");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
String *listOfCustomerReferences = listOfCustomerReferences_example; // List of customerReference for the transactions to be retrieved (comma separated string) Ex: 'ref01,ref02,ref03' (the customerReference is originally passed in the transaction request by the developer when processing a payment) (default to null)

// This endpoint retrieves the details of a specific group of transactions based on a list of customer references.
[apiInstance getTxnsByCustomerReferenceWith:listOfCustomerReferences
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var listOfCustomerReferences = listOfCustomerReferences_example; // {String} List of customerReference for the transactions to be retrieved (comma separated string) Ex: 'ref01,ref02,ref03' (the customerReference is originally passed in the transaction request by the developer when processing a payment)

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTxnsByCustomerReference(listOfCustomerReferences, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getTxnsByCustomerReferenceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var listOfCustomerReferences = listOfCustomerReferences_example;  // String | List of customerReference for the transactions to be retrieved (comma separated string) Ex: 'ref01,ref02,ref03' (the customerReference is originally passed in the transaction request by the developer when processing a payment) (default to null)

            try {
                // This endpoint retrieves the details of a specific group of transactions based on a list of customer references.
                TransactionDetailsResult result = apiInstance.getTxnsByCustomerReference(listOfCustomerReferences);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getTxnsByCustomerReference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$listOfCustomerReferences = listOfCustomerReferences_example; // String | List of customerReference for the transactions to be retrieved (comma separated string) Ex: 'ref01,ref02,ref03' (the customerReference is originally passed in the transaction request by the developer when processing a payment)

try {
    $result = $api_instance->getTxnsByCustomerReference($listOfCustomerReferences);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getTxnsByCustomerReference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $listOfCustomerReferences = listOfCustomerReferences_example; # String | List of customerReference for the transactions to be retrieved (comma separated string) Ex: 'ref01,ref02,ref03' (the customerReference is originally passed in the transaction request by the developer when processing a payment)

eval { 
    my $result = $api_instance->getTxnsByCustomerReference(listOfCustomerReferences => $listOfCustomerReferences);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getTxnsByCustomerReference: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
listOfCustomerReferences = listOfCustomerReferences_example # String | List of customerReference for the transactions to be retrieved (comma separated string) Ex: 'ref01,ref02,ref03' (the customerReference is originally passed in the transaction request by the developer when processing a payment) (default to null)

try: 
    # This endpoint retrieves the details of a specific group of transactions based on a list of customer references.
    api_response = api_instance.get_txns_by_customer_reference(listOfCustomerReferences)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getTxnsByCustomerReference: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let listOfCustomerReferences = listOfCustomerReferences_example; // String

    let mut context = TransactionsApi::Context::default();
    let result = client.getTxnsByCustomerReference(listOfCustomerReferences, &context).wait();

    println!("{:?}", result);
}

Parameters

Query parameters
Name Description
listOfCustomerReferences *

List of customerReference for the transactions to be retrieved (comma separated string) Ex: 'ref01,ref02,ref03' (the customerReference is originally passed in the transaction request by the developer when processing a payment)

Responses


getTxnsByGuids

This endpoint retrieves the details of a specific group of transactions based on their GUIDs.
/transactions/guids

Usage and SDK Samples

curl -X GET \
-H "AnalyticsApiKey: Your-Api-Key" \
-H "Accept: application/json" \
 \
"https://txnfeed.handpoint.com/transactions/guids?listOfGuids="
                            
import com.handpoint.api.txnfeed.*;
import com.handpoint.api.txnfeed.auth.*;
import com.handpoint.api.txnfeed.model.*;
import com.handpoint.api.txnfeed.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Create an instance of the API class
        TransactionsApi apiInstance = new TransactionsApi();
        String listOfGuids = listOfGuids_example; // String | List of target GUIDs (comma separated string) Ex: 'GUID1,GUID2,GUID3'
        
        try {
            TransactionDetailsResult result = apiInstance.getTxnsByGuids(listOfGuids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTxnsByGuids");
            e.printStackTrace();
        }
    }
}
import com.handpoint.api.txnfeed.api.TransactionsApi;

public class TransactionsApiExample {
    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String listOfGuids = listOfGuids_example; // String | List of target GUIDs (comma separated string) Ex: 'GUID1,GUID2,GUID3'
        
        try {
            TransactionDetailsResult result = apiInstance.getTxnsByGuids(listOfGuids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTxnsByGuids");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"AnalyticsApiKey"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"AnalyticsApiKey"];


// Create an instance of the API class
TransactionsApi *apiInstance = [[TransactionsApi alloc] init];
String *listOfGuids = listOfGuids_example; // List of target GUIDs (comma separated string) Ex: 'GUID1,GUID2,GUID3' (default to null)

// This endpoint retrieves the details of a specific group of transactions based on their GUIDs.
[apiInstance getTxnsByGuidsWith:listOfGuids
              completionHandler: ^(TransactionDetailsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TxnFeedApi = require('txn_feed_api');
var defaultClient = TxnFeedApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new TxnFeedApi.TransactionsApi()
var listOfGuids = listOfGuids_example; // {String} List of target GUIDs (comma separated string) Ex: 'GUID1,GUID2,GUID3'

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTxnsByGuids(listOfGuids, callback);
using System;
using System.Diagnostics;
using Com.Handpoint.Api.Txnfeed.Api;
using Com.Handpoint.Api.Txnfeed.Client;
using Com.Handpoint.Api.Txnfeed.Model;

namespace Example
{
    public class getTxnsByGuidsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("AnalyticsApiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("AnalyticsApiKey", "Bearer");
            
            // Create an instance of the API class
            var apiInstance = new TransactionsApi();
            var listOfGuids = listOfGuids_example;  // String | List of target GUIDs (comma separated string) Ex: 'GUID1,GUID2,GUID3' (default to null)

            try {
                // This endpoint retrieves the details of a specific group of transactions based on their GUIDs.
                TransactionDetailsResult result = apiInstance.getTxnsByGuids(listOfGuids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TransactionsApi.getTxnsByGuids: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKey('AnalyticsApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// ComHandpointApiTxnfeed\Configuration::getDefaultConfiguration()->setApiKeyPrefix('AnalyticsApiKey', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TransactionsApi();
$listOfGuids = listOfGuids_example; // String | List of target GUIDs (comma separated string) Ex: 'GUID1,GUID2,GUID3'

try {
    $result = $api_instance->getTxnsByGuids($listOfGuids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getTxnsByGuids: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use Com::Handpoint::Api::Txnfeed::Configuration;
use Com::Handpoint::Api::Txnfeed::TransactionsApi;

# Configure API key authorization: ApiKeyAuth
$Com::Handpoint::Api::Txnfeed::Configuration::api_key->{'AnalyticsApiKey'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Com::Handpoint::Api::Txnfeed::Configuration::api_key_prefix->{'AnalyticsApiKey'} = "Bearer";

# Create an instance of the API class
my $api_instance = Com::Handpoint::Api::Txnfeed::TransactionsApi->new();
my $listOfGuids = listOfGuids_example; # String | List of target GUIDs (comma separated string) Ex: 'GUID1,GUID2,GUID3'

eval { 
    my $result = $api_instance->getTxnsByGuids(listOfGuids => $listOfGuids);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getTxnsByGuids: $@\n";
}
from __future__ import print_statement
import time
import com.handpoint.api.txnfeed
from com.handpoint.api.txnfeed.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
com.handpoint.api.txnfeed.configuration.api_key['AnalyticsApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# com.handpoint.api.txnfeed.configuration.api_key_prefix['AnalyticsApiKey'] = 'Bearer'

# Create an instance of the API class
api_instance = com.handpoint.api.txnfeed.TransactionsApi()
listOfGuids = listOfGuids_example # String | List of target GUIDs (comma separated string) Ex: 'GUID1,GUID2,GUID3' (default to null)

try: 
    # This endpoint retrieves the details of a specific group of transactions based on their GUIDs.
    api_response = api_instance.get_txns_by_guids(listOfGuids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getTxnsByGuids: %s\n" % e)
extern crate TransactionsApi;

pub fn main() {
    let listOfGuids = listOfGuids_example; // String

    let mut context = TransactionsApi::Context::default();
    let result = client.getTxnsByGuids(listOfGuids, &context).wait();

    println!("{:?}", result);
}

Parameters

Query parameters
Name Description
listOfGuids *

List of target GUIDs (comma separated string) Ex: 'GUID1,GUID2,GUID3'

Responses