|
| 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 | +<a name="getPaymentBatchSummary"></a> |
| 11 | +# **getPaymentBatchSummary** |
| 12 | +> ReportingV3PaymentBatchSummariesGet200Response getPaymentBatchSummary(startTime, endTime, opts) |
| 13 | +
|
| 14 | +Get payment batch summary data |
| 15 | + |
| 16 | +Scope can be either account/merchant or reseller. |
| 17 | + |
| 18 | +### Example |
| 19 | +```javascript |
| 20 | +var CyberSource = require('CyberSource'); |
| 21 | + |
| 22 | +var apiInstance = new CyberSource.PaymentBatchSummariesApi(); |
| 23 | + |
| 24 | +var startTime = new Date("2013-10-20T19:20:30+01:00"); // Date | 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) |
| 25 | + |
| 26 | +var endTime = new Date("2013-10-20T19:20:30+01:00"); // Date | 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) |
| 27 | + |
| 28 | +var opts = { |
| 29 | + 'organizationId': "organizationId_example", // String | Valid Cybersource Organization Id |
| 30 | + 'rollUp': "rollUp_example", // String | Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant |
| 31 | + 'breakdown': "breakdown_example", // String | Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. |
| 32 | + 'startDayOfWeek': 56 // Number | Optional - Start day of week to breakdown data for weeks in a month |
| 33 | +}; |
| 34 | + |
| 35 | +var callback = function(error, data, response) { |
| 36 | + if (error) { |
| 37 | + console.error(error); |
| 38 | + } else { |
| 39 | + console.log('API called successfully. Returned data: ' + data); |
| 40 | + } |
| 41 | +}; |
| 42 | +apiInstance.getPaymentBatchSummary(startTime, endTime, opts, callback); |
| 43 | +``` |
| 44 | + |
| 45 | +### Parameters |
| 46 | + |
| 47 | +Name | Type | Description | Notes |
| 48 | +------------- | ------------- | ------------- | ------------- |
| 49 | + **startTime** | **Date**| 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) | |
| 50 | + **endTime** | **Date**| 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) | |
| 51 | + **organizationId** | **String**| Valid Cybersource Organization Id | [optional] |
| 52 | + **rollUp** | **String**| Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant | [optional] |
| 53 | + **breakdown** | **String**| Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. | [optional] |
| 54 | + **startDayOfWeek** | **Number**| Optional - Start day of week to breakdown data for weeks in a month | [optional] |
| 55 | + |
| 56 | +### Return type |
| 57 | + |
| 58 | +[**ReportingV3PaymentBatchSummariesGet200Response**](ReportingV3PaymentBatchSummariesGet200Response.md) |
| 59 | + |
| 60 | +### Authorization |
| 61 | + |
| 62 | +No authorization required |
| 63 | + |
| 64 | +### HTTP request headers |
| 65 | + |
| 66 | + - **Content-Type**: application/json;charset=utf-8 |
| 67 | + - **Accept**: application/hal+json |
| 68 | + |
0 commit comments