|
| 1 | +# CyberSource\PaymentBatchSummariesApi |
| 2 | + |
| 3 | +All URIs are relative to *https://apitest.cybersource.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**getPaymentBatchSummary**](PaymentBatchSummariesApi.md#getPaymentBatchSummary) | **GET** /reporting/v3/payment-batch-summaries | Get payment batch summary data |
| 8 | + |
| 9 | + |
| 10 | +# **getPaymentBatchSummary** |
| 11 | +> \CyberSource\Model\ReportingV3PaymentBatchSummariesGet200Response getPaymentBatchSummary($startTime, $endTime, $organizationId, $rollUp, $breakdown, $startDayOfWeek) |
| 12 | +
|
| 13 | +Get payment batch summary data |
| 14 | + |
| 15 | +Scope can be either account/merchant or reseller. |
| 16 | + |
| 17 | +### Example |
| 18 | +```php |
| 19 | +<?php |
| 20 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 21 | + |
| 22 | +$api_instance = new CyberSource\Api\PaymentBatchSummariesApi(); |
| 23 | +$startTime = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
| 24 | +$endTime = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
| 25 | +$organizationId = "organizationId_example"; // string | Valid Cybersource Organization Id |
| 26 | +$rollUp = "rollUp_example"; // string | Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant |
| 27 | +$breakdown = "breakdown_example"; // string | Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. |
| 28 | +$startDayOfWeek = 56; // int | Optional - Start day of week to breakdown data for weeks in a month |
| 29 | + |
| 30 | +try { |
| 31 | + $result = $api_instance->getPaymentBatchSummary($startTime, $endTime, $organizationId, $rollUp, $breakdown, $startDayOfWeek); |
| 32 | + print_r($result); |
| 33 | +} catch (Exception $e) { |
| 34 | + echo 'Exception when calling PaymentBatchSummariesApi->getPaymentBatchSummary: ', $e->getMessage(), PHP_EOL; |
| 35 | +} |
| 36 | +?> |
| 37 | +``` |
| 38 | + |
| 39 | +### Parameters |
| 40 | + |
| 41 | +Name | Type | Description | Notes |
| 42 | +------------- | ------------- | ------------- | ------------- |
| 43 | + **startTime** | **\DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | |
| 44 | + **endTime** | **\DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | |
| 45 | + **organizationId** | **string**| Valid Cybersource Organization Id | [optional] |
| 46 | + **rollUp** | **string**| Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant | [optional] |
| 47 | + **breakdown** | **string**| Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. | [optional] |
| 48 | + **startDayOfWeek** | **int**| Optional - Start day of week to breakdown data for weeks in a month | [optional] |
| 49 | + |
| 50 | +### Return type |
| 51 | + |
| 52 | +[**\CyberSource\Model\ReportingV3PaymentBatchSummariesGet200Response**](../Model/ReportingV3PaymentBatchSummariesGet200Response.md) |
| 53 | + |
| 54 | +### Authorization |
| 55 | + |
| 56 | +No authorization required |
| 57 | + |
| 58 | +### HTTP request headers |
| 59 | + |
| 60 | + - **Content-Type**: application/json;charset=utf-8 |
| 61 | + - **Accept**: application/hal+json |
| 62 | + |
| 63 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 64 | + |
0 commit comments