Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion docs/ConversionDetailsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ No authorization required
### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/hal+json
- **Accept**: application/hal+json, application/xml

1 change: 1 addition & 0 deletions docs/CreateInstrumentIdentifierRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **String** | Type of Card | [optional]
**card** | [**Tmsv1instrumentidentifiersCard**](Tmsv1instrumentidentifiersCard.md) | | [optional]
**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional]
**billTo** | [**Tmsv1instrumentidentifiersBillTo**](Tmsv1instrumentidentifiersBillTo.md) | | [optional]


Expand Down
53 changes: 53 additions & 0 deletions docs/DownloadDTDApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# DownloadDTDApi

All URIs are relative to *https://apitest.cybersource.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getDTDV2**](DownloadDTDApi.md#getDTDV2) | **GET** /dtds/{reportDefinitionNameVersion} | Used to download DTDs for reports


<a name="getDTDV2"></a>
# **getDTDV2**
> getDTDV2(reportDefinitionNameVersion)

Used to download DTDs for reports

Downloads DTDs for reports on no-auth.

### Example
```java
// Import classes:
//import Invokers.ApiException;
//import Api.DownloadDTDApi;


DownloadDTDApi apiInstance = new DownloadDTDApi();
String reportDefinitionNameVersion = "reportDefinitionNameVersion_example"; // String | Name and version of DTD file to download. Some DTDs only have one version. In that case version name is not needed. Some example values are ctdr-1.0, tdr, pbdr-1.1
try {
apiInstance.getDTDV2(reportDefinitionNameVersion);
} catch (ApiException e) {
System.err.println("Exception when calling DownloadDTDApi#getDTDV2");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**reportDefinitionNameVersion** | **String**| Name and version of DTD file to download. Some DTDs only have one version. In that case version name is not needed. Some example values are ctdr-1.0, tdr, pbdr-1.1 |

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/xml-dtd

53 changes: 53 additions & 0 deletions docs/DownloadXSDApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# DownloadXSDApi

All URIs are relative to *https://apitest.cybersource.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getXSDV2**](DownloadXSDApi.md#getXSDV2) | **GET** /xsds/{reportDefinitionNameVersion} | Used to download XSDs for reports


<a name="getXSDV2"></a>
# **getXSDV2**
> getXSDV2(reportDefinitionNameVersion)

Used to download XSDs for reports

Downloads XSDs for reports on no-auth.

### Example
```java
// Import classes:
//import Invokers.ApiException;
//import Api.DownloadXSDApi;


DownloadXSDApi apiInstance = new DownloadXSDApi();
String reportDefinitionNameVersion = "reportDefinitionNameVersion_example"; // String | Name and version of XSD file to download. Some XSDs only have one version. In that case version name is not needed. Some example values are DecisionManagerDetailReport, DecisionManagerTypes
try {
apiInstance.getXSDV2(reportDefinitionNameVersion);
} catch (ApiException e) {
System.err.println("Exception when calling DownloadXSDApi#getXSDV2");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**reportDefinitionNameVersion** | **String**| Name and version of XSD file to download. Some XSDs only have one version. In that case version name is not needed. Some example values are DecisionManagerDetailReport, DecisionManagerTypes |

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: text/xml

4 changes: 2 additions & 2 deletions docs/EmbeddedInstrumentIdentifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional]
**object** | **String** | &#39;Describes type of token.&#39; Valid values: - instrumentIdentifier | [optional]
**state** | **String** | &#39;Current state of the token.&#39; Valid values: - ACTIVE - CLOSED | [optional]
**state** | **String** | &#39;Current state of the token.&#39; Valid values: - ACTIVE - CLOSED | [optional]
**id** | **String** | The ID of the existing instrument identifier to be linked to the newly created payment instrument. | [optional]
**card** | [**TmsV1InstrumentIdentifiersPost200ResponseCard**](TmsV1InstrumentIdentifiersPost200ResponseCard.md) | | [optional]
**bankAccount** | [**TmsV1InstrumentIdentifiersPost200ResponseBankAccount**](TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md) | | [optional]
**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional]
**processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional]
**metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional]

Expand Down
5 changes: 2 additions & 3 deletions docs/Error.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **String** | | [optional]
**message** | **String** | The detailed message related to the type stated above. | [optional]
**details** | [**Tmsv1instrumentidentifiersDetails**](Tmsv1instrumentidentifiersDetails.md) | | [optional]
**responseStatus** | [**InlineResponseDefaultResponseStatus**](InlineResponseDefaultResponseStatus.md) | | [optional]
**links** | [**ErrorLinks**](ErrorLinks.md) | | [optional]



2 changes: 1 addition & 1 deletion docs/ErrorBean.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**localizationKey** | **String** | Localization Key Name | [optional]
**correlationId** | **String** | Correlation Id | [optional]
**detail** | **String** | Error Detail | [optional]
**fields** | [**List&lt;InlineResponse400Fields&gt;**](InlineResponse400Fields.md) | Error fields List | [optional]
**fields** | [**List&lt;InlineResponse4001Fields&gt;**](InlineResponse4001Fields.md) | Error fields List | [optional]



4 changes: 2 additions & 2 deletions docs/ErrorLinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**next** | [**List&lt;InlineResponseDefaultLinksNext&gt;**](InlineResponseDefaultLinksNext.md) | | [optional]
**documentation** | [**List&lt;InlineResponseDefaultLinksNext&gt;**](InlineResponseDefaultLinksNext.md) | | [optional]
**self** | [**InlineResponseDefaultLinksNext**](InlineResponseDefaultLinksNext.md) | | [optional]
**documentation** | [**List&lt;InlineResponseDefaultLinksNext&gt;**](InlineResponseDefaultLinksNext.md) | | [optional]
**next** | [**List&lt;InlineResponseDefaultLinksNext&gt;**](InlineResponseDefaultLinksNext.md) | | [optional]



2 changes: 2 additions & 0 deletions docs/ErrorResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**responseStatus** | [**InlineResponseDefaultResponseStatus**](InlineResponseDefaultResponseStatus.md) | | [optional]
**links** | [**InlineResponseDefaultLinks**](InlineResponseDefaultLinks.md) | | [optional]



9 changes: 3 additions & 6 deletions docs/InlineResponse400.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **String** | Error code |
**message** | **String** | Error message |
**localizationKey** | **String** | Localization Key Name | [optional]
**correlationId** | **String** | Correlation Id | [optional]
**detail** | **String** | Error Detail | [optional]
**fields** | [**List&lt;InlineResponse400Fields&gt;**](InlineResponse400Fields.md) | Error fields List | [optional]
**type** | **String** | | [optional]
**message** | **String** | The detailed message related to the type stated above. | [optional]
**details** | [**Tmsv1instrumentidentifiersDetails**](Tmsv1instrumentidentifiersDetails.md) | | [optional]



9 changes: 6 additions & 3 deletions docs/InlineResponse4001.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **String** | | [optional]
**message** | **String** | The detailed message related to the type stated above. | [optional]
**details** | [**Tmsv1instrumentidentifiersDetails**](Tmsv1instrumentidentifiersDetails.md) | | [optional]
**code** | **String** | Error code |
**message** | **String** | Error message |
**localizationKey** | **String** | Localization Key Name | [optional]
**correlationId** | **String** | Correlation Id | [optional]
**detail** | **String** | Error Detail | [optional]
**fields** | [**List&lt;InlineResponse4001Fields&gt;**](InlineResponse4001Fields.md) | Error fields List | [optional]



Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# InlineResponse400Fields
# InlineResponse4001Fields

## Properties
Name | Type | Description | Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/InstrumentIdentifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**object** | **String** | &#39;Describes type of token.&#39; Valid values: - instrumentIdentifier | [optional]
**state** | **String** | &#39;Current state of the token.&#39; Valid values: - ACTIVE - CLOSED | [optional]
**card** | [**TmsV1InstrumentIdentifiersPost200ResponseCard**](TmsV1InstrumentIdentifiersPost200ResponseCard.md) | | [optional]
**bankAccount** | [**TmsV1InstrumentIdentifiersPost200ResponseBankAccount**](TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md) | | [optional]
**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional]
**processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional]
**metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional]

Expand Down
1 change: 1 addition & 0 deletions docs/InstrumentIdentifierEnrollableCard.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **String** | Type of Card | [optional]
**card** | [**Tmsv1instrumentidentifiersCard**](Tmsv1instrumentidentifiersCard.md) | | [optional]
**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional]
**billTo** | [**Tmsv1instrumentidentifiersBillTo**](Tmsv1instrumentidentifiersBillTo.md) | | [optional]


Expand Down
4 changes: 3 additions & 1 deletion docs/Link.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**href** | **String** | | [optional]
**href** | **String** | URI of the linked resource. | [optional]
**title** | **String** | Label of the linked resource. | [optional]
**method** | **String** | HTTP method of the linked resource. | [optional]



6 changes: 3 additions & 3 deletions docs/Links.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**self** | [**TmsV1InstrumentIdentifiersPost200ResponseLinksSelf**](TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md) | | [optional]
**ancestor** | [**TmsV1InstrumentIdentifiersPost200ResponseLinksSelf**](TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md) | | [optional]
**successor** | [**TmsV1InstrumentIdentifiersPost200ResponseLinksSelf**](TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md) | | [optional]
**self** | [**InlineResponseDefaultLinksNext**](InlineResponseDefaultLinksNext.md) | | [optional]
**documentation** | [**List&lt;InlineResponseDefaultLinksNext&gt;**](InlineResponseDefaultLinksNext.md) | | [optional]
**next** | [**List&lt;InlineResponseDefaultLinksNext&gt;**](InlineResponseDefaultLinksNext.md) | | [optional]



2 changes: 1 addition & 1 deletion docs/NetFundingsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ No authorization required
### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/hal+json
- **Accept**: application/hal+json, application/xml

64 changes: 64 additions & 0 deletions docs/PaymentBatchSummariesApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# PaymentBatchSummariesApi

All URIs are relative to *https://apitest.cybersource.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getPaymentBatchSummary**](PaymentBatchSummariesApi.md#getPaymentBatchSummary) | **GET** /reporting/v3/payment-batch-summaries | Get payment batch summary data


<a name="getPaymentBatchSummary"></a>
# **getPaymentBatchSummary**
> ReportingV3PaymentBatchSummariesGet200Response getPaymentBatchSummary(startTime, endTime, organizationId, rollUp, breakdown, startDayOfWeek)

Get payment batch summary data

Scope can be either account/merchant or reseller.

### Example
```java
// Import classes:
//import Invokers.ApiException;
//import Api.PaymentBatchSummariesApi;


PaymentBatchSummariesApi apiInstance = new PaymentBatchSummariesApi();
DateTime startTime = new DateTime(); // 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)
DateTime endTime = new DateTime(); // 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)
String organizationId = "organizationId_example"; // String | Valid Cybersource Organization Id
String rollUp = "rollUp_example"; // String | Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant
String breakdown = "breakdown_example"; // String | Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant.
Integer startDayOfWeek = 56; // Integer | Optional - Start day of week to breakdown data for weeks in a month
try {
ReportingV3PaymentBatchSummariesGet200Response result = apiInstance.getPaymentBatchSummary(startTime, endTime, organizationId, rollUp, breakdown, startDayOfWeek);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentBatchSummariesApi#getPaymentBatchSummary");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
**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&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) |
**organizationId** | **String**| Valid Cybersource Organization Id | [optional]
**rollUp** | **String**| Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant | [optional]
**breakdown** | **String**| Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. | [optional]
**startDayOfWeek** | **Integer**| Optional - Start day of week to breakdown data for weeks in a month | [optional]

### Return type

[**ReportingV3PaymentBatchSummariesGet200Response**](ReportingV3PaymentBatchSummariesGet200Response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/hal+json

2 changes: 1 addition & 1 deletion docs/PtsV2PaymentsPost201ResponseIssuerInformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**country** | **String** | Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character ISO Standard Country Codes. This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions. For details, see &#x60;auth_card_issuer_country&#x60; field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional]
**discretionaryData** | **String** | Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **Visa Platform Connect**. For details, see &#x60;issuer_additional_data&#x60; field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional]
**discretionaryData** | **String** | Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see &#x60;issuer_additional_data&#x60; field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional]
**responseCode** | **String** | Additional authorization code that must be printed on the receipt when returned by the processor. This value is generated by the processor and is returned only for a successful transaction. This field is supported only on FDC Nashville Global and SIX. | [optional]


Expand Down
Loading