Skip to content

Commit b80198c

Browse files
gnongsiegnongsie
authored
Merge pull request #79 from CyberSource/oct-2021
October 2021 Release
2 parents a934a76 + 68385bf commit b80198c

File tree

64 files changed

+5533
-72
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+5533
-72
lines changed

‎docs/ChargebackDetailsApi.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# CyberSource.ChargebackDetailsApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getChargebackDetails**](ChargebackDetailsApi.md#getChargebackDetails) | **GET** /reporting/v3/chargeback-details | Get Chargeback Details
8+
9+
10+
<a name="getChargebackDetails"></a>
11+
# **getChargebackDetails**
12+
> ReportingV3ChargebackDetailsGet200Response getChargebackDetails(startTime, endTime, opts)
13+
14+
Get Chargeback Details
15+
16+
Chargeback Detail Report Description
17+
18+
### Example
19+
```javascript
20+
var CyberSource = require('CyberSource');
21+
22+
var apiInstance = new CyberSource.ChargebackDetailsApi();
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 Organization Id
30+
};
31+
32+
var callback = function(error, data, response) {
33+
if (error) {
34+
console.error(error);
35+
} else {
36+
console.log('API called successfully. Returned data: ' + data);
37+
}
38+
};
39+
apiInstance.getChargebackDetails(startTime, endTime, opts, callback);
40+
```
41+
42+
### Parameters
43+
44+
Name | Type | Description | Notes
45+
------------- | ------------- | ------------- | -------------
46+
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
47+
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
48+
**organizationId** | **String**| Valid Organization Id | [optional]
49+
50+
### Return type
51+
52+
[**ReportingV3ChargebackDetailsGet200Response**](ReportingV3ChargebackDetailsGet200Response.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, application/xml
62+

‎docs/ChargebackSummariesApi.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# CyberSource.ChargebackSummariesApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getChargebackSummaries**](ChargebackSummariesApi.md#getChargebackSummaries) | **GET** /reporting/v3/chargeback-summaries | Get Chargeback Summaries
8+
9+
10+
<a name="getChargebackSummaries"></a>
11+
# **getChargebackSummaries**
12+
> ReportingV3ChargebackSummariesGet200Response getChargebackSummaries(startTime, endTime, opts)
13+
14+
Get Chargeback Summaries
15+
16+
Chargeback Summary Report Description
17+
18+
### Example
19+
```javascript
20+
var CyberSource = require('CyberSource');
21+
22+
var apiInstance = new CyberSource.ChargebackSummariesApi();
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 Organization Id
30+
};
31+
32+
var callback = function(error, data, response) {
33+
if (error) {
34+
console.error(error);
35+
} else {
36+
console.log('API called successfully. Returned data: ' + data);
37+
}
38+
};
39+
apiInstance.getChargebackSummaries(startTime, endTime, opts, callback);
40+
```
41+
42+
### Parameters
43+
44+
Name | Type | Description | Notes
45+
------------- | ------------- | ------------- | -------------
46+
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
47+
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
48+
**organizationId** | **String**| Valid Organization Id | [optional]
49+
50+
### Return type
51+
52+
[**ReportingV3ChargebackSummariesGet200Response**](ReportingV3ChargebackSummariesGet200Response.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, application/xml
62+

‎docs/ConversionDetailsApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var startTime = new Date("2013-10-20T19:20:30+01:00"); // Date | Valid report St
2626
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)
2727

2828
var opts = {
29-
'organizationId': "organizationId_example" // String | Valid Cybersource Organization Id
29+
'organizationId': "organizationId_example" // String | Valid Organization Id
3030
};
3131

3232
var callback = function(error, data, response) {
@@ -45,7 +45,7 @@ Name | Type | Description | Notes
4545
------------- | ------------- | ------------- | -------------
4646
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
4747
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
48-
**organizationId** | **String**| Valid Cybersource Organization Id | [optional]
48+
**organizationId** | **String**| Valid Organization Id | [optional]
4949

5050
### Return type
5151

‎docs/InterchangeClearingLevelDetailsApi.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# CyberSource.InterchangeClearingLevelDetailsApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getInterchangeClearingLevelDetails**](InterchangeClearingLevelDetailsApi.md#getInterchangeClearingLevelDetails) | **GET** /reporting/v3/interchange-clearing-level-details | Interchange Clearing Level data for an account or a merchant
8+
9+
10+
<a name="getInterchangeClearingLevelDetails"></a>
11+
# **getInterchangeClearingLevelDetails**
12+
> ReportingV3InterchangeClearingLevelDetailsGet200Response getInterchangeClearingLevelDetails(startTime, endTime, opts)
13+
14+
Interchange Clearing Level data for an account or a merchant
15+
16+
Interchange Clearing Level data for an account or a merchant
17+
18+
### Example
19+
```javascript
20+
var CyberSource = require('CyberSource');
21+
22+
var apiInstance = new CyberSource.InterchangeClearingLevelDetailsApi();
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 Organization Id
30+
};
31+
32+
var callback = function(error, data, response) {
33+
if (error) {
34+
console.error(error);
35+
} else {
36+
console.log('API called successfully. Returned data: ' + data);
37+
}
38+
};
39+
apiInstance.getInterchangeClearingLevelDetails(startTime, endTime, opts, callback);
40+
```
41+
42+
### Parameters
43+
44+
Name | Type | Description | Notes
45+
------------- | ------------- | ------------- | -------------
46+
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
47+
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
48+
**organizationId** | **String**| Valid Organization Id | [optional]
49+
50+
### Return type
51+
52+
[**ReportingV3InterchangeClearingLevelDetailsGet200Response**](ReportingV3InterchangeClearingLevelDetailsGet200Response.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, application/xml
62+

‎docs/NetFundingsApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var startTime = new Date("2013-10-20T19:20:30+01:00"); // Date | Valid report St
2626
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)
2727

2828
var opts = {
29-
'organizationId': "organizationId_example", // String | Valid Cybersource Organization Id
29+
'organizationId': "organizationId_example", // String | Valid Organization Id
3030
'groupName': "groupName_example" // String | Valid CyberSource Group Name.
3131
};
3232

@@ -46,7 +46,7 @@ Name | Type | Description | Notes
4646
------------- | ------------- | ------------- | -------------
4747
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
4848
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
49-
**organizationId** | **String**| Valid Cybersource Organization Id | [optional]
49+
**organizationId** | **String**| Valid Organization Id | [optional]
5050
**groupName** | **String**| Valid CyberSource Group Name. | [optional]
5151

5252
### Return type

‎docs/PaymentBatchSummariesApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var startTime = new Date("2013-10-20T19:20:30+01:00"); // Date | Valid report St
2626
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)
2727

2828
var opts = {
29-
'organizationId': "organizationId_example", // String | Valid Cybersource Organization Id
29+
'organizationId': "organizationId_example", // String | Valid Organization Id
3030
'rollUp': "rollUp_example", // String | Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant
3131
'breakdown': "breakdown_example", // String | Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant.
3232
'startDayOfWeek': 56 // Number | Optional - Start day of week to breakdown data for weeks in a month
@@ -48,7 +48,7 @@ Name | Type | Description | Notes
4848
------------- | ------------- | ------------- | -------------
4949
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
5050
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
51-
**organizationId** | **String**| Valid Cybersource Organization Id | [optional]
51+
**organizationId** | **String**| Valid Organization Id | [optional]
5252
**rollUp** | **String**| Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant | [optional]
5353
**breakdown** | **String**| Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. | [optional]
5454
**startDayOfWeek** | **Number**| Optional - Start day of week to breakdown data for weeks in a month | [optional]

‎docs/Ptsv2paymentsClientReferenceInformation.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**code** | **String** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional]
7+
**pausedRequestId** | **String** | Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call. | [optional]
78
**transactionId** | **String** | Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests. | [optional]
89
**comments** | **String** | Comments | [optional]
910
**partner** | [**Ptsv2paymentsClientReferenceInformationPartner**](Ptsv2paymentsClientReferenceInformationPartner.md) | | [optional]

‎docs/PurchaseAndRefundDetailsApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var startTime = new Date("2013-10-20T19:20:30+01:00"); // Date | Valid report St
2626
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)
2727

2828
var opts = {
29-
'organizationId': "organizationId_example", // String | Valid Cybersource Organization Id
29+
'organizationId': "organizationId_example", // String | Valid Organization Id
3030
'paymentSubtype': "ALL", // String | Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit
3131
'viewBy': "requestDate", // String | View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date
3232
'groupName': "groupName_example", // String | Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds
@@ -50,7 +50,7 @@ Name | Type | Description | Notes
5050
------------- | ------------- | ------------- | -------------
5151
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
5252
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
53-
**organizationId** | **String**| Valid Cybersource Organization Id | [optional]
53+
**organizationId** | **String**| Valid Organization Id | [optional]
5454
**paymentSubtype** | **String**| Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit | [optional] [default to ALL]
5555
**viewBy** | **String**| View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date | [optional] [default to requestDate]
5656
**groupName** | **String**| Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds | [optional]

0 commit comments

Comments
 (0)