diff --git a/docs/BatchesApi.md b/docs/BatchesApi.md index 0c66a1ccb..c8bdd6836 100644 --- a/docs/BatchesApi.md +++ b/docs/BatchesApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description # **getBatchReport** -> InlineResponse2007 getBatchReport(batchId) +> InlineResponse2004 getBatchReport(batchId) Retrieve a Batch Report @@ -28,7 +28,7 @@ Retrieve a Batch Report BatchesApi apiInstance = new BatchesApi(); String batchId = "batchId_example"; // String | Unique identification number assigned to the submitted request. try { - InlineResponse2007 result = apiInstance.getBatchReport(batchId); + InlineResponse2004 result = apiInstance.getBatchReport(batchId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BatchesApi#getBatchReport"); @@ -44,7 +44,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2007**](InlineResponse2007.md) +[**InlineResponse2004**](InlineResponse2004.md) ### Authorization @@ -57,7 +57,7 @@ No authorization required # **getBatchStatus** -> InlineResponse2006 getBatchStatus(batchId) +> InlineResponse2003 getBatchStatus(batchId) Retrieve a Batch Status @@ -73,7 +73,7 @@ Retrieve a Batch Status BatchesApi apiInstance = new BatchesApi(); String batchId = "batchId_example"; // String | Unique identification number assigned to the submitted request. try { - InlineResponse2006 result = apiInstance.getBatchStatus(batchId); + InlineResponse2003 result = apiInstance.getBatchStatus(batchId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BatchesApi#getBatchStatus"); @@ -89,7 +89,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2006**](InlineResponse2006.md) +[**InlineResponse2003**](InlineResponse2003.md) ### Authorization @@ -102,7 +102,7 @@ No authorization required # **getBatchesList** -> InlineResponse2005 getBatchesList(offset, limit, fromDate, toDate) +> InlineResponse2002 getBatchesList(offset, limit, fromDate, toDate) List Batches @@ -121,7 +121,7 @@ Long limit = 20L; // Long | The maximum number that can be returned in the array String fromDate = "fromDate_example"; // String | ISO-8601 format: yyyyMMddTHHmmssZ String toDate = "toDate_example"; // String | ISO-8601 format: yyyyMMddTHHmmssZ try { - InlineResponse2005 result = apiInstance.getBatchesList(offset, limit, fromDate, toDate); + InlineResponse2002 result = apiInstance.getBatchesList(offset, limit, fromDate, toDate); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BatchesApi#getBatchesList"); @@ -140,7 +140,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2005**](InlineResponse2005.md) +[**InlineResponse2002**](InlineResponse2002.md) ### Authorization diff --git a/docs/CreateNewWebhooksApi.md b/docs/CreateNewWebhooksApi.md index 6d8fbb949..3464b7838 100644 --- a/docs/CreateNewWebhooksApi.md +++ b/docs/CreateNewWebhooksApi.md @@ -4,108 +4,16 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**createWebhookSubscription**](CreateNewWebhooksApi.md#createWebhookSubscription) | **POST** /notification-subscriptions/v1/webhooks | Create a Webhook -[**findProductsToSubscribe**](CreateNewWebhooksApi.md#findProductsToSubscribe) | **GET** /notification-subscriptions/v1/products/{organizationId} | Find Products You Can Subscribe To [**saveSymEgressKey**](CreateNewWebhooksApi.md#saveSymEgressKey) | **POST** /kms/egress/v2/keys-sym | Create Webhook Security Keys - -# **createWebhookSubscription** -> InlineResponse2014 createWebhookSubscription(createWebhookRequest) - -Create a Webhook - -Create a new webhook subscription. Before creating a webhook, ensure that a security key has been created at the top of this developer center section. You will not need to pass us back the key during the creation of the webhook, but you will receive an error if you did not already create a key or store one on file. - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.CreateNewWebhooksApi; - - -CreateNewWebhooksApi apiInstance = new CreateNewWebhooksApi(); -CreateWebhookRequest createWebhookRequest = new CreateWebhookRequest(); // CreateWebhookRequest | The webhook payload -try { - InlineResponse2014 result = apiInstance.createWebhookSubscription(createWebhookRequest); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling CreateNewWebhooksApi#createWebhookSubscription"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **createWebhookRequest** | [**CreateWebhookRequest**](CreateWebhookRequest.md)| The webhook payload | [optional] - -### Return type - -[**InlineResponse2014**](InlineResponse2014.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - - -# **findProductsToSubscribe** -> List<InlineResponse2002> findProductsToSubscribe(organizationId) - -Find Products You Can Subscribe To - -Retrieve a list of products and event types that your account is eligible for. These products and events are the ones that you may subscribe to in the next step of creating webhooks. - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.CreateNewWebhooksApi; - - -CreateNewWebhooksApi apiInstance = new CreateNewWebhooksApi(); -String organizationId = "organizationId_example"; // String | The Organization Identifier. -try { - List result = apiInstance.findProductsToSubscribe(organizationId); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling CreateNewWebhooksApi#findProductsToSubscribe"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizationId** | **String**| The Organization Identifier. | - -### Return type - -[**List<InlineResponse2002>**](InlineResponse2002.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - # **saveSymEgressKey** > InlineResponse2013 saveSymEgressKey(vCSenderOrganizationId, vCPermissions, vCCorrelationId, saveSymEgressKey) Create Webhook Security Keys -Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature. Select the CREATE example for CyberSource to generate the key on our server and maintain it for you as well. Remeber to save the key in the API response, so that you can use it to validate messages later. +Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature. Select the CREATE example for CyberSource to generate the key on our server and maintain it for you as well. Remember to save the key in the API response, so that you can use it to validate messages later. ### Example ```java @@ -148,5 +56,5 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 diff --git a/docs/CreateWebhookRequest.md b/docs/CreateWebhookRequest.md deleted file mode 100644 index e66029a67..000000000 --- a/docs/CreateWebhookRequest.md +++ /dev/null @@ -1,19 +0,0 @@ - -# CreateWebhookRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | Client friendly webhook name. | [optional] -**description** | **String** | Client friendly webhook description. | [optional] -**organizationId** | **String** | Organization Identifier (OrgId) or Merchant Identifier (MID). | [optional] -**productId** | **String** | To see the valid productId and eventTypes, call the \"Create and Manage Webhooks - Retrieve a list of event types\" endpoint. | [optional] -**eventTypes** | **List<String>** | Array of the different events for a given product id. | [optional] -**webhookUrl** | **String** | The client's endpoint (URL) to receive webhooks. | [optional] -**healthCheckUrl** | **String** | The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. If the user does not provide the health check URL, it is the user's responsibility to re-activate the webhook if it is deactivated by calling the test endpoint. | [optional] -**notificationScope** | **String** | The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. 3. CUSTOM The Webhook is used to deliver webhooks for the OrgIds (or MiDs) explicitly listed in scopeData field. | [optional] -**retryPolicy** | [**Notificationsubscriptionsv1webhooksRetryPolicy**](Notificationsubscriptionsv1webhooksRetryPolicy.md) | | [optional] -**securityPolicy** | [**Notificationsubscriptionsv1webhooksSecurityPolicy1**](Notificationsubscriptionsv1webhooksSecurityPolicy1.md) | | [optional] - - - diff --git a/docs/GenerateUnifiedCheckoutCaptureContextRequest.md b/docs/GenerateUnifiedCheckoutCaptureContextRequest.md index 13ea0d3de..a0b68ab7c 100644 --- a/docs/GenerateUnifiedCheckoutCaptureContextRequest.md +++ b/docs/GenerateUnifiedCheckoutCaptureContextRequest.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **clientVersion** | **String** | Specify the version of Unified Checkout that you want to use. | [optional] **targetOrigins** | **List<String>** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Unified Checkout is defined by the scheme (protocol), hostname (domain) and port number (if used). You must use https://hostname (unless you use http://localhost) Wildcards are NOT supported. Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc) Examples: - https://example.com - https://subdomain.example.com - https://example.com:8080<br><br> If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ \"https://example.com\", \"https://basket.example.com\", \"https://ecom.example.com\" ] | [optional] **allowedCardNetworks** | **List<String>** | The list of card networks you want to use for this Unified Checkout transaction. Unified Checkout currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA | [optional] -**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field. | [optional] +**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.<br><br> **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay. | [optional] **country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional] **locale** | **String** | Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code. Please refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html) | [optional] **captureMandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional] diff --git a/docs/InlineResponse2002.md b/docs/InlineResponse2002.md index 9c1416ba1..e18773a79 100644 --- a/docs/InlineResponse2002.md +++ b/docs/InlineResponse2002.md @@ -4,9 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productId** | **String** | Product ID. | [optional] -**productName** | **String** | Product Name. | [optional] -**eventTypes** | [**List<Notificationsubscriptionsv1productsorganizationIdEventTypes>**](Notificationsubscriptionsv1productsorganizationIdEventTypes.md) | | [optional] +**links** | [**List<InlineResponse2002Links>**](InlineResponse2002Links.md) | | [optional] +**object** | **String** | | [optional] +**offset** | **Integer** | | [optional] +**limit** | **Integer** | | [optional] +**count** | **Integer** | | [optional] +**total** | **Integer** | | [optional] +**embedded** | [**InlineResponse2002Embedded**](InlineResponse2002Embedded.md) | | [optional] diff --git a/docs/InlineResponse2002Embedded.md b/docs/InlineResponse2002Embedded.md new file mode 100644 index 000000000..912c837c3 --- /dev/null +++ b/docs/InlineResponse2002Embedded.md @@ -0,0 +1,10 @@ + +# InlineResponse2002Embedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batches** | [**List<InlineResponse2002EmbeddedBatches>**](InlineResponse2002EmbeddedBatches.md) | | [optional] + + + diff --git a/docs/InlineResponse2005EmbeddedBatches.md b/docs/InlineResponse2002EmbeddedBatches.md similarity index 81% rename from docs/InlineResponse2005EmbeddedBatches.md rename to docs/InlineResponse2002EmbeddedBatches.md index ae725aa30..1f32341f6 100644 --- a/docs/InlineResponse2005EmbeddedBatches.md +++ b/docs/InlineResponse2002EmbeddedBatches.md @@ -1,10 +1,10 @@ -# InlineResponse2005EmbeddedBatches +# InlineResponse2002EmbeddedBatches ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**InlineResponse2005EmbeddedLinks**](InlineResponse2005EmbeddedLinks.md) | | [optional] +**links** | [**InlineResponse2002EmbeddedLinks**](InlineResponse2002EmbeddedLinks.md) | | [optional] **batchId** | **String** | Unique identification number assigned to the submitted request. | [optional] **batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] **batchModifiedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] @@ -13,7 +13,7 @@ Name | Type | Description | Notes **merchantReference** | **String** | Reference used by merchant to identify batch. | [optional] **batchCaEndpoints** | **List<String>** | Valid Values: * VISA * MASTERCARD * AMEX | [optional] **status** | **String** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETE | [optional] -**totals** | [**InlineResponse2005EmbeddedTotals**](InlineResponse2005EmbeddedTotals.md) | | [optional] +**totals** | [**InlineResponse2002EmbeddedTotals**](InlineResponse2002EmbeddedTotals.md) | | [optional] diff --git a/docs/InlineResponse2002EmbeddedLinks.md b/docs/InlineResponse2002EmbeddedLinks.md new file mode 100644 index 000000000..c06b10a7a --- /dev/null +++ b/docs/InlineResponse2002EmbeddedLinks.md @@ -0,0 +1,10 @@ + +# InlineResponse2002EmbeddedLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reports** | [**List<InlineResponse2002EmbeddedLinksReports>**](InlineResponse2002EmbeddedLinksReports.md) | | [optional] + + + diff --git a/docs/InlineResponse2005EmbeddedLinksReports.md b/docs/InlineResponse2002EmbeddedLinksReports.md similarity index 78% rename from docs/InlineResponse2005EmbeddedLinksReports.md rename to docs/InlineResponse2002EmbeddedLinksReports.md index 0d0e6436e..4ecea7dc8 100644 --- a/docs/InlineResponse2005EmbeddedLinksReports.md +++ b/docs/InlineResponse2002EmbeddedLinksReports.md @@ -1,5 +1,5 @@ -# InlineResponse2005EmbeddedLinksReports +# InlineResponse2002EmbeddedLinksReports ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2005EmbeddedTotals.md b/docs/InlineResponse2002EmbeddedTotals.md similarity index 91% rename from docs/InlineResponse2005EmbeddedTotals.md rename to docs/InlineResponse2002EmbeddedTotals.md index 1fae7df8c..47b94fbb3 100644 --- a/docs/InlineResponse2005EmbeddedTotals.md +++ b/docs/InlineResponse2002EmbeddedTotals.md @@ -1,5 +1,5 @@ -# InlineResponse2005EmbeddedTotals +# InlineResponse2002EmbeddedTotals ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2005Links.md b/docs/InlineResponse2002Links.md similarity index 90% rename from docs/InlineResponse2005Links.md rename to docs/InlineResponse2002Links.md index ca4ebba7f..0184c9311 100644 --- a/docs/InlineResponse2005Links.md +++ b/docs/InlineResponse2002Links.md @@ -1,5 +1,5 @@ -# InlineResponse2005Links +# InlineResponse2002Links ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2003.md b/docs/InlineResponse2003.md index 2a23054f6..edb2bfbaa 100644 --- a/docs/InlineResponse2003.md +++ b/docs/InlineResponse2003.md @@ -4,20 +4,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**webhookId** | **String** | Webhook Id. This is generated by the server. | [optional] -**organizationId** | **String** | Organization ID. | [optional] -**products** | [**List<Notificationsubscriptionsv1webhooksProducts>**](Notificationsubscriptionsv1webhooksProducts.md) | | [optional] -**webhookUrl** | **String** | The client's endpoint (URL) to receive webhooks. | [optional] -**healthCheckUrl** | **String** | The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. | [optional] -**notificationScope** | [**Notificationsubscriptionsv1webhooksNotificationScope**](Notificationsubscriptionsv1webhooksNotificationScope.md) | | [optional] -**status** | **String** | Webhook status. | [optional] -**name** | **String** | Client friendly webhook name. | [optional] -**description** | **String** | Client friendly webhook description. | [optional] -**retryPolicy** | [**Notificationsubscriptionsv1webhooksRetryPolicy**](Notificationsubscriptionsv1webhooksRetryPolicy.md) | | [optional] -**securityPolicy** | [**Notificationsubscriptionsv1webhooksSecurityPolicy**](Notificationsubscriptionsv1webhooksSecurityPolicy.md) | | [optional] -**createdOn** | **String** | Date on which webhook was created/registered. | [optional] -**updatedOn** | **String** | Date on which webhook was most recently updated. | [optional] -**additionalAttributes** | [**List<Map<String, String>>**](Map.md) | Additional, free form configuration data. | [optional] +**links** | [**InlineResponse2003Links**](InlineResponse2003Links.md) | | [optional] +**batchId** | **String** | Unique identification number assigned to the submitted request. | [optional] +**batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] +**batchSource** | **String** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional] +**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional] +**batchCaEndpoints** | **String** | | [optional] +**status** | **String** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETED | [optional] +**totals** | [**InlineResponse2002EmbeddedTotals**](InlineResponse2002EmbeddedTotals.md) | | [optional] +**billing** | [**InlineResponse2003Billing**](InlineResponse2003Billing.md) | | [optional] +**description** | **String** | | [optional] diff --git a/docs/InlineResponse2006Billing.md b/docs/InlineResponse2003Billing.md similarity index 90% rename from docs/InlineResponse2006Billing.md rename to docs/InlineResponse2003Billing.md index d3931455d..3d2b2a53d 100644 --- a/docs/InlineResponse2006Billing.md +++ b/docs/InlineResponse2003Billing.md @@ -1,5 +1,5 @@ -# InlineResponse2006Billing +# InlineResponse2003Billing ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2006Links.md b/docs/InlineResponse2003Links.md similarity index 60% rename from docs/InlineResponse2006Links.md rename to docs/InlineResponse2003Links.md index 3acb095c2..67aca8af2 100644 --- a/docs/InlineResponse2006Links.md +++ b/docs/InlineResponse2003Links.md @@ -1,11 +1,11 @@ -# InlineResponse2006Links +# InlineResponse2003Links ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **self** | [**InlineResponse202LinksStatus**](InlineResponse202LinksStatus.md) | | [optional] -**report** | [**List<InlineResponse2006LinksReport>**](InlineResponse2006LinksReport.md) | | [optional] +**report** | [**List<InlineResponse2003LinksReport>**](InlineResponse2003LinksReport.md) | | [optional] diff --git a/docs/InlineResponse2006LinksReport.md b/docs/InlineResponse2003LinksReport.md similarity index 82% rename from docs/InlineResponse2006LinksReport.md rename to docs/InlineResponse2003LinksReport.md index c3c2cb8ae..9507c3303 100644 --- a/docs/InlineResponse2006LinksReport.md +++ b/docs/InlineResponse2003LinksReport.md @@ -1,5 +1,5 @@ -# InlineResponse2006LinksReport +# InlineResponse2003LinksReport ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2004.md b/docs/InlineResponse2004.md index 38b37ec3f..d0e16fc59 100644 --- a/docs/InlineResponse2004.md +++ b/docs/InlineResponse2004.md @@ -4,20 +4,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**webhookId** | **String** | Webhook Id. This is generated by the server. | [optional] -**organizationId** | **String** | Organization ID. | [optional] -**products** | [**List<Notificationsubscriptionsv1webhooksProducts>**](Notificationsubscriptionsv1webhooksProducts.md) | | [optional] -**webhookUrl** | **String** | The client's endpoint (URL) to receive webhooks. | [optional] -**healthCheckUrl** | **String** | The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. | [optional] -**notificationScope** | [**Notificationsubscriptionsv1webhooksNotificationScope**](Notificationsubscriptionsv1webhooksNotificationScope.md) | | [optional] -**status** | **String** | Webhook status. | [optional] -**name** | **String** | Client friendly webhook name. | [optional] -**description** | **String** | Client friendly webhook description. | [optional] -**retryPolicy** | [**Notificationsubscriptionsv1webhooksRetryPolicy**](Notificationsubscriptionsv1webhooksRetryPolicy.md) | | [optional] -**securityPolicy** | [**Notificationsubscriptionsv1webhooksSecurityPolicy**](Notificationsubscriptionsv1webhooksSecurityPolicy.md) | | [optional] -**createdOn** | **String** | Date on which webhook was created/registered. | [optional] -**updatedOn** | **String** | Date on which webhook was most recently updated. | [optional] -**additionalAttributes** | [**List<Map<String, String>>**](Map.md) | Additional, free form configuration data. | [optional] +**version** | **String** | | [optional] +**reportCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] +**batchId** | **String** | Unique identification number assigned to the submitted request. | [optional] +**batchSource** | **String** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional] +**batchCaEndpoints** | **String** | | [optional] +**batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] +**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional] +**totals** | [**InlineResponse2002EmbeddedTotals**](InlineResponse2002EmbeddedTotals.md) | | [optional] +**billing** | [**InlineResponse2003Billing**](InlineResponse2003Billing.md) | | [optional] +**records** | [**List<InlineResponse2004Records>**](InlineResponse2004Records.md) | | [optional] diff --git a/docs/InlineResponse2004Records.md b/docs/InlineResponse2004Records.md new file mode 100644 index 000000000..18523ee5a --- /dev/null +++ b/docs/InlineResponse2004Records.md @@ -0,0 +1,12 @@ + +# InlineResponse2004Records + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**sourceRecord** | [**InlineResponse2004SourceRecord**](InlineResponse2004SourceRecord.md) | | [optional] +**responseRecord** | [**InlineResponse2004ResponseRecord**](InlineResponse2004ResponseRecord.md) | | [optional] + + + diff --git a/docs/InlineResponse2007ResponseRecord.md b/docs/InlineResponse2004ResponseRecord.md similarity index 81% rename from docs/InlineResponse2007ResponseRecord.md rename to docs/InlineResponse2004ResponseRecord.md index a24f1b768..6589c2cf4 100644 --- a/docs/InlineResponse2007ResponseRecord.md +++ b/docs/InlineResponse2004ResponseRecord.md @@ -1,5 +1,5 @@ -# InlineResponse2007ResponseRecord +# InlineResponse2004ResponseRecord ## Properties Name | Type | Description | Notes @@ -13,7 +13,7 @@ Name | Type | Description | Notes **cardExpiryMonth** | **String** | | [optional] **cardExpiryYear** | **String** | | [optional] **cardType** | **String** | | [optional] -**additionalUpdates** | [**List<InlineResponse2007ResponseRecordAdditionalUpdates>**](InlineResponse2007ResponseRecordAdditionalUpdates.md) | | [optional] +**additionalUpdates** | [**List<InlineResponse2004ResponseRecordAdditionalUpdates>**](InlineResponse2004ResponseRecordAdditionalUpdates.md) | | [optional] diff --git a/docs/InlineResponse2007ResponseRecordAdditionalUpdates.md b/docs/InlineResponse2004ResponseRecordAdditionalUpdates.md similarity index 87% rename from docs/InlineResponse2007ResponseRecordAdditionalUpdates.md rename to docs/InlineResponse2004ResponseRecordAdditionalUpdates.md index 5a4f14995..b0fffdca7 100644 --- a/docs/InlineResponse2007ResponseRecordAdditionalUpdates.md +++ b/docs/InlineResponse2004ResponseRecordAdditionalUpdates.md @@ -1,5 +1,5 @@ -# InlineResponse2007ResponseRecordAdditionalUpdates +# InlineResponse2004ResponseRecordAdditionalUpdates ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2007SourceRecord.md b/docs/InlineResponse2004SourceRecord.md similarity index 93% rename from docs/InlineResponse2007SourceRecord.md rename to docs/InlineResponse2004SourceRecord.md index 1568aedc5..d6ce8a237 100644 --- a/docs/InlineResponse2007SourceRecord.md +++ b/docs/InlineResponse2004SourceRecord.md @@ -1,5 +1,5 @@ -# InlineResponse2007SourceRecord +# InlineResponse2004SourceRecord ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2005.md b/docs/InlineResponse2005.md deleted file mode 100644 index c1bcaf2af..000000000 --- a/docs/InlineResponse2005.md +++ /dev/null @@ -1,16 +0,0 @@ - -# InlineResponse2005 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**List<InlineResponse2005Links>**](InlineResponse2005Links.md) | | [optional] -**object** | **String** | | [optional] -**offset** | **Integer** | | [optional] -**limit** | **Integer** | | [optional] -**count** | **Integer** | | [optional] -**total** | **Integer** | | [optional] -**embedded** | [**InlineResponse2005Embedded**](InlineResponse2005Embedded.md) | | [optional] - - - diff --git a/docs/InlineResponse2005Embedded.md b/docs/InlineResponse2005Embedded.md deleted file mode 100644 index 8d96a5f97..000000000 --- a/docs/InlineResponse2005Embedded.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2005Embedded - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**batches** | [**List<InlineResponse2005EmbeddedBatches>**](InlineResponse2005EmbeddedBatches.md) | | [optional] - - - diff --git a/docs/InlineResponse2005EmbeddedLinks.md b/docs/InlineResponse2005EmbeddedLinks.md deleted file mode 100644 index 93bb26ee8..000000000 --- a/docs/InlineResponse2005EmbeddedLinks.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2005EmbeddedLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reports** | [**List<InlineResponse2005EmbeddedLinksReports>**](InlineResponse2005EmbeddedLinksReports.md) | | [optional] - - - diff --git a/docs/InlineResponse2006.md b/docs/InlineResponse2006.md deleted file mode 100644 index e88b697ea..000000000 --- a/docs/InlineResponse2006.md +++ /dev/null @@ -1,19 +0,0 @@ - -# InlineResponse2006 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse2006Links**](InlineResponse2006Links.md) | | [optional] -**batchId** | **String** | Unique identification number assigned to the submitted request. | [optional] -**batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] -**batchSource** | **String** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional] -**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional] -**batchCaEndpoints** | **String** | | [optional] -**status** | **String** | Valid Values: * REJECTED * RECEIVED * VALIDATED * DECLINED * PROCESSING * COMPLETED | [optional] -**totals** | [**InlineResponse2005EmbeddedTotals**](InlineResponse2005EmbeddedTotals.md) | | [optional] -**billing** | [**InlineResponse2006Billing**](InlineResponse2006Billing.md) | | [optional] -**description** | **String** | | [optional] - - - diff --git a/docs/InlineResponse2007.md b/docs/InlineResponse2007.md deleted file mode 100644 index 787fdd04c..000000000 --- a/docs/InlineResponse2007.md +++ /dev/null @@ -1,19 +0,0 @@ - -# InlineResponse2007 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**version** | **String** | | [optional] -**reportCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] -**batchId** | **String** | Unique identification number assigned to the submitted request. | [optional] -**batchSource** | **String** | Valid Values: * SCHEDULER * TOKEN_API * CREDIT_CARD_FILE_UPLOAD * AMEX_REGSITRY * AMEX_REGISTRY_API * AMEX_MAINTENANCE | [optional] -**batchCaEndpoints** | **String** | | [optional] -**batchCreatedDate** | **String** | ISO-8601 format: yyyy-MM-ddTHH:mm:ssZ | [optional] -**merchantReference** | **String** | Reference used by merchant to identify batch. | [optional] -**totals** | [**InlineResponse2005EmbeddedTotals**](InlineResponse2005EmbeddedTotals.md) | | [optional] -**billing** | [**InlineResponse2006Billing**](InlineResponse2006Billing.md) | | [optional] -**records** | [**List<InlineResponse2007Records>**](InlineResponse2007Records.md) | | [optional] - - - diff --git a/docs/InlineResponse2007Records.md b/docs/InlineResponse2007Records.md deleted file mode 100644 index 3b3e34710..000000000 --- a/docs/InlineResponse2007Records.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse2007Records - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | [optional] -**sourceRecord** | [**InlineResponse2007SourceRecord**](InlineResponse2007SourceRecord.md) | | [optional] -**responseRecord** | [**InlineResponse2007ResponseRecord**](InlineResponse2007ResponseRecord.md) | | [optional] - - - diff --git a/docs/InlineResponse2014.md b/docs/InlineResponse2014.md index d9fa6e41b..fd685e9f7 100644 --- a/docs/InlineResponse2014.md +++ b/docs/InlineResponse2014.md @@ -4,21 +4,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**webhookId** | **String** | Webhook Id. This is generated by the server. | [optional] -**organizationId** | **String** | Organization ID | [optional] -**productId** | **String** | The product you are receiving a webhook for. | [optional] -**eventTypes** | **List<String>** | Array of the different events for a given product id. | [optional] -**webhookUrl** | **String** | The client's endpoint (URL) to receive webhooks. | [optional] -**healthCheckUrl** | **String** | The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. | [optional] -**notificationScope** | [**Notificationsubscriptionsv1webhooksNotificationScope**](Notificationsubscriptionsv1webhooksNotificationScope.md) | | [optional] -**status** | **String** | Webhook status. | [optional] -**name** | **String** | Client friendly webhook name. | [optional] -**description** | **String** | Client friendly webhook description. | [optional] -**retryPolicy** | [**Notificationsubscriptionsv1webhooksRetryPolicy**](Notificationsubscriptionsv1webhooksRetryPolicy.md) | | [optional] -**securityPolicy** | [**Notificationsubscriptionsv1webhooksSecurityPolicy**](Notificationsubscriptionsv1webhooksSecurityPolicy.md) | | [optional] -**createdOn** | **String** | Date on which webhook was created/registered. | [optional] -**updatedOn** | **String** | Date on which webhook was most recently updated. | [optional] -**additionalAttributes** | [**List<Map<String, String>>**](Map.md) | Additional, free form configuration data. | [optional] +**eventDate** | **String** | Date that the webhook was delivered | [optional] +**eventType** | **String** | The event name the webhook was delivered for | [optional] +**organizationId** | **String** | The Organization Identifier. | [optional] +**payloads** | [**InlineResponse2014Payloads**](InlineResponse2014Payloads.md) | | [optional] +**productId** | **String** | The product the webhook was delivered for | [optional] +**requestType** | **String** | Identifies the the type of request | [optional] +**retryNumber** | **Integer** | The number of retry attempts for a given webhook | [optional] +**transactionTraceId** | **String** | The identifier for the webhook | [optional] +**webhookId** | **String** | The identifier of the subscription | [optional] diff --git a/docs/InlineResponse2014Payloads.md b/docs/InlineResponse2014Payloads.md new file mode 100644 index 000000000..5aa2938d8 --- /dev/null +++ b/docs/InlineResponse2014Payloads.md @@ -0,0 +1,10 @@ + +# InlineResponse2014Payloads + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**testPayload** | [**InlineResponse2014PayloadsTestPayload**](InlineResponse2014PayloadsTestPayload.md) | | [optional] + + + diff --git a/docs/InlineResponse2014PayloadsTestPayload.md b/docs/InlineResponse2014PayloadsTestPayload.md new file mode 100644 index 000000000..62a60d445 --- /dev/null +++ b/docs/InlineResponse2014PayloadsTestPayload.md @@ -0,0 +1,10 @@ + +# InlineResponse2014PayloadsTestPayload + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **String** | The test message delivered in the webhook | [optional] + + + diff --git a/docs/InlineResponse2015.md b/docs/InlineResponse2015.md index 741bed854..5db3bd7eb 100644 --- a/docs/InlineResponse2015.md +++ b/docs/InlineResponse2015.md @@ -6,8 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | **String** | The status of the submitted transaction. Possible values: - ACCEPTED | [optional] -**clientReferenceInformation** | [**Kmsegressv2keyssymClientReferenceInformation**](Kmsegressv2keyssymClientReferenceInformation.md) | | [optional] -**keyInformation** | [**Kmsegressv2keysasymKeyInformation**](Kmsegressv2keysasymKeyInformation.md) | | [optional] diff --git a/docs/InlineResponse4042.md b/docs/InlineResponse4042.md deleted file mode 100644 index 1563fa1a9..000000000 --- a/docs/InlineResponse4042.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse4042 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **String** | | [optional] -**message** | **String** | | [optional] -**details** | [**List<InlineResponse4042Details>**](InlineResponse4042Details.md) | | [optional] - - - diff --git a/docs/InlineResponse4042Details.md b/docs/InlineResponse4042Details.md deleted file mode 100644 index a3ea03338..000000000 --- a/docs/InlineResponse4042Details.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse4042Details - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**field** | **String** | | [optional] -**reason** | **String** | | [optional] - - - diff --git a/docs/ManageWebhooksApi.md b/docs/ManageWebhooksApi.md index bc43f06f7..19610f9b4 100644 --- a/docs/ManageWebhooksApi.md +++ b/docs/ManageWebhooksApi.md @@ -4,20 +4,17 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**deleteWebhookSubscription**](ManageWebhooksApi.md#deleteWebhookSubscription) | **DELETE** /notification-subscriptions/v1/webhooks/{webhookId} | Delete a Webhook Subscription -[**getWebhookSubscriptionById**](ManageWebhooksApi.md#getWebhookSubscriptionById) | **GET** /notification-subscriptions/v1/webhooks/{webhookId} | Get Details On a Single Webhook -[**getWebhookSubscriptionsByOrg**](ManageWebhooksApi.md#getWebhookSubscriptionsByOrg) | **GET** /notification-subscriptions/v1/webhooks | Get Details On All Created Webhooks +[**notificationSubscriptionsV1WebhooksWebhookIdPost**](ManageWebhooksApi.md#notificationSubscriptionsV1WebhooksWebhookIdPost) | **POST** /notification-subscriptions/v1/webhooks/{webhookId} | Test a Webhook Configuration [**saveAsymEgressKey**](ManageWebhooksApi.md#saveAsymEgressKey) | **POST** /kms/egress/v2/keys-asym | Message Level Encryption -[**updateWebhookSubscription**](ManageWebhooksApi.md#updateWebhookSubscription) | **PATCH** /notification-subscriptions/v1/webhooks/{webhookId} | Update a Webhook Subscription - -# **deleteWebhookSubscription** -> deleteWebhookSubscription(webhookId) + +# **notificationSubscriptionsV1WebhooksWebhookIdPost** +> InlineResponse2014 notificationSubscriptionsV1WebhooksWebhookIdPost(webhookId) -Delete a Webhook Subscription +Test a Webhook Configuration -Delete the webhook. Please note that deleting a particular webhook does not delete the history of the webhook notifications. +Test the webhook configuration by sending a sample webhook. Calling this endpoint sends a sample webhook to the endpoint identified in the user's subscription. It will contain sample values for the product & eventType based on values present in your subscription along with a sample message in the payload. Based on the webhook response users can make any necessary modifications or rest assured knowing their setup is configured correctly. ### Example ```java @@ -27,103 +24,12 @@ Delete the webhook. Please note that deleting a particular webhook does not dele ManageWebhooksApi apiInstance = new ManageWebhooksApi(); -String webhookId = "webhookId_example"; // String | The webhook identifier. -try { - apiInstance.deleteWebhookSubscription(webhookId); -} catch (ApiException e) { - System.err.println("Exception when calling ManageWebhooksApi#deleteWebhookSubscription"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **webhookId** | **String**| The webhook identifier. | - -### Return type - -null (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - - -# **getWebhookSubscriptionById** -> InlineResponse2004 getWebhookSubscriptionById(webhookId) - -Get Details On a Single Webhook - -Retrieve the details of a specific webhook by supplying the webhook ID in the path. - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.ManageWebhooksApi; - - -ManageWebhooksApi apiInstance = new ManageWebhooksApi(); -String webhookId = "webhookId_example"; // String | The webhook Identifier -try { - InlineResponse2004 result = apiInstance.getWebhookSubscriptionById(webhookId); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling ManageWebhooksApi#getWebhookSubscriptionById"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **webhookId** | **String**| The webhook Identifier | - -### Return type - -[**InlineResponse2004**](InlineResponse2004.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - - -# **getWebhookSubscriptionsByOrg** -> List<InlineResponse2003> getWebhookSubscriptionsByOrg(organizationId, productId, eventType) - -Get Details On All Created Webhooks - -Retrieve a list of all previously created webhooks. - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.ManageWebhooksApi; - - -ManageWebhooksApi apiInstance = new ManageWebhooksApi(); -String organizationId = "organizationId_example"; // String | The Organization Identifier. -String productId = "productId_example"; // String | The Product Identifier. -String eventType = "eventType_example"; // String | The Event Type. +String webhookId = "webhookId_example"; // String | The Webhook Identifier. try { - List result = apiInstance.getWebhookSubscriptionsByOrg(organizationId, productId, eventType); + InlineResponse2014 result = apiInstance.notificationSubscriptionsV1WebhooksWebhookIdPost(webhookId); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling ManageWebhooksApi#getWebhookSubscriptionsByOrg"); + System.err.println("Exception when calling ManageWebhooksApi#notificationSubscriptionsV1WebhooksWebhookIdPost"); e.printStackTrace(); } ``` @@ -132,13 +38,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizationId** | **String**| The Organization Identifier. | - **productId** | **String**| The Product Identifier. | - **eventType** | **String**| The Event Type. | + **webhookId** | **String**| The Webhook Identifier. | ### Return type -[**List<InlineResponse2003>**](InlineResponse2003.md) +[**InlineResponse2014**](InlineResponse2014.md) ### Authorization @@ -147,7 +51,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 # **saveAsymEgressKey** @@ -198,51 +102,5 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - - -# **updateWebhookSubscription** -> updateWebhookSubscription(webhookId, updateWebhookRequest) - -Update a Webhook Subscription - -Update the webhook subscription using PATCH. - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.ManageWebhooksApi; - - -ManageWebhooksApi apiInstance = new ManageWebhooksApi(); -String webhookId = "webhookId_example"; // String | The Webhook Identifier. -UpdateWebhookRequest updateWebhookRequest = new UpdateWebhookRequest(); // UpdateWebhookRequest | The webhook payload or changes to apply. -try { - apiInstance.updateWebhookSubscription(webhookId, updateWebhookRequest); -} catch (ApiException e) { - System.err.println("Exception when calling ManageWebhooksApi#updateWebhookSubscription"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **webhookId** | **String**| The Webhook Identifier. | - **updateWebhookRequest** | [**UpdateWebhookRequest**](UpdateWebhookRequest.md)| The webhook payload or changes to apply. | [optional] - -### Return type - -null (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 diff --git a/docs/Model400UploadBatchFileResponse.md b/docs/Model400UploadBatchFileResponse.md new file mode 100644 index 000000000..8d69a7575 --- /dev/null +++ b/docs/Model400UploadBatchFileResponse.md @@ -0,0 +1,11 @@ + +# Model400UploadBatchFileResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **String** | | [optional] +**message** | **String** | | [optional] + + + diff --git a/docs/Notificationsubscriptionsv1productsorganizationIdEventTypes.md b/docs/Notificationsubscriptionsv1productsorganizationIdEventTypes.md deleted file mode 100644 index 16ac93b36..000000000 --- a/docs/Notificationsubscriptionsv1productsorganizationIdEventTypes.md +++ /dev/null @@ -1,14 +0,0 @@ - -# Notificationsubscriptionsv1productsorganizationIdEventTypes - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**eventName** | **String** | | [optional] -**displayName** | **String** | | [optional] -**frequency** | **Integer** | | [optional] -**timeSensitivity** | **Boolean** | | [optional] -**payloadEncryption** | **Boolean** | | [optional] - - - diff --git a/docs/Notificationsubscriptionsv1webhooksNotificationScope.md b/docs/Notificationsubscriptionsv1webhooksNotificationScope.md deleted file mode 100644 index a830cb2ff..000000000 --- a/docs/Notificationsubscriptionsv1webhooksNotificationScope.md +++ /dev/null @@ -1,11 +0,0 @@ - -# Notificationsubscriptionsv1webhooksNotificationScope - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**scope** | **String** | The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. 3. CUSTOM The Webhook is used to deliver webhooks for the OrgIds (or MiDs) explicitly listed in scopeData field | [optional] -**scopeData** | **List<String>** | Applicable only if scope=CUSTOM. This should contains a Set of MIDs or OrgIDs for which this subscription is applicable. | [optional] - - - diff --git a/docs/Notificationsubscriptionsv1webhooksProducts.md b/docs/Notificationsubscriptionsv1webhooksProducts.md deleted file mode 100644 index 6dd736095..000000000 --- a/docs/Notificationsubscriptionsv1webhooksProducts.md +++ /dev/null @@ -1,11 +0,0 @@ - -# Notificationsubscriptionsv1webhooksProducts - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**productId** | **String** | Product ID. | [optional] -**eventTypes** | **List<String>** | | [optional] - - - diff --git a/docs/Notificationsubscriptionsv1webhooksRetryPolicy.md b/docs/Notificationsubscriptionsv1webhooksRetryPolicy.md deleted file mode 100644 index 4c2d28d0a..000000000 --- a/docs/Notificationsubscriptionsv1webhooksRetryPolicy.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Notificationsubscriptionsv1webhooksRetryPolicy - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**algorithm** | **String** | This is used to calculate the Retry Sequence. Sample calculations using firstRetry=10, interval=30, maxNumberOfRetries=3 Arithmetic = a+r(n-1) Retry 1 - 10 minutes Retry 2 - 10+30x1 = 40 minutes Retry 3 - 10+30x2 = 70 minutes Geometric = ar^(n-1) Retry 1 - 10 minutes Retry 2 - 10x30^1 = 300 minutes Retry 3 - 10x30^2 = 9,000 minutes | [optional] -**firstRetry** | **Integer** | When to initiate first retry, after the initial call failed. (in mins). | [optional] -**interval** | **Integer** | The interval between retries (in mins). | [optional] -**numberOfRetries** | **Integer** | The number of retries per sequence. | [optional] -**deactivateFlag** | **String** | Deactivate the subscription if your retries fail to deliver. If this is set to `true`, the automatic suspend and resume feature will occur. This would prevent new webhooks from attempting to deliver and to queue up until your healthCheckUrl returns 200 again, then all messages will be sent. If this is set to `false`, new individual messages will continue to retry and exhaust all failures, but the subscription will stay active. | [optional] -**repeatSequenceCount** | **Integer** | The number of times to repeat the complete retry sequence. 0 => don't repeat the retry sequence 1 => repeat the retry sequence once (R1, R2, R3)+ (R1, R2, R3) 2 => repeat the retry sequence twice (R1, R2, R3) + (R1, R2, R3) + (R1, R2, R3) | [optional] -**repeatSequenceWaitTime** | **Integer** | The time to wait to before repeating the complete retry sequence. Amount of time to wait between each sequence. Sample calculation using repeatSequenceWaitTime=10 (R1, R2, R3) + (10) + (R1, R2, R3) + (10) + (R1, R2, R3) | [optional] -**additionalAttributes** | [**List<Map<String, String>>**](Map.md) | Additional data, if any. | [optional] - - - diff --git a/docs/Notificationsubscriptionsv1webhooksSecurityPolicy.md b/docs/Notificationsubscriptionsv1webhooksSecurityPolicy.md deleted file mode 100644 index 0e1e579d5..000000000 --- a/docs/Notificationsubscriptionsv1webhooksSecurityPolicy.md +++ /dev/null @@ -1,11 +0,0 @@ - -# Notificationsubscriptionsv1webhooksSecurityPolicy - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**securityType** | **String** | Security Policy of the client server. | [optional] -**config** | [**Notificationsubscriptionsv1webhooksSecurityPolicyConfig**](Notificationsubscriptionsv1webhooksSecurityPolicyConfig.md) | | [optional] - - - diff --git a/docs/Notificationsubscriptionsv1webhooksSecurityPolicy1.md b/docs/Notificationsubscriptionsv1webhooksSecurityPolicy1.md deleted file mode 100644 index c16fff1b4..000000000 --- a/docs/Notificationsubscriptionsv1webhooksSecurityPolicy1.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Notificationsubscriptionsv1webhooksSecurityPolicy1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**securityType** | **String** | Security Policy of the client server. | [optional] -**proxyType** | **String** | Internal client proxy type to be used by security policy. | [optional] -**config** | [**Notificationsubscriptionsv1webhooksSecurityPolicy1Config**](Notificationsubscriptionsv1webhooksSecurityPolicy1Config.md) | | [optional] - - - diff --git a/docs/Notificationsubscriptionsv1webhooksSecurityPolicy1Config.md b/docs/Notificationsubscriptionsv1webhooksSecurityPolicy1Config.md deleted file mode 100644 index 3cf8a73fd..000000000 --- a/docs/Notificationsubscriptionsv1webhooksSecurityPolicy1Config.md +++ /dev/null @@ -1,13 +0,0 @@ - -# Notificationsubscriptionsv1webhooksSecurityPolicy1Config - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**oAuthTokenExpiry** | **String** | Token expiration for the oAuth server. | [optional] -**oAuthURL** | **String** | Client direct endpoint to the oAuth server. | [optional] -**oAuthTokenType** | **String** | Token type for the oAuth config. | [optional] -**additionalConfig** | [**Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig**](Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig.md) | | [optional] - - - diff --git a/docs/Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig.md b/docs/Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig.md deleted file mode 100644 index 6b31d8e73..000000000 --- a/docs/Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig.md +++ /dev/null @@ -1,13 +0,0 @@ - -# Notificationsubscriptionsv1webhooksSecurityPolicy1ConfigAdditionalConfig - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**aud** | **String** | | [optional] -**clientId** | **String** | | [optional] -**keyId** | **String** | | [optional] -**scope** | **String** | | [optional] - - - diff --git a/docs/Notificationsubscriptionsv1webhooksSecurityPolicyConfig.md b/docs/Notificationsubscriptionsv1webhooksSecurityPolicyConfig.md deleted file mode 100644 index 11d253a93..000000000 --- a/docs/Notificationsubscriptionsv1webhooksSecurityPolicyConfig.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Notificationsubscriptionsv1webhooksSecurityPolicyConfig - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**oAuthTokenExpiry** | **String** | Token expiration for the oAuth server. | [optional] -**oAuthURL** | **String** | Client direct endpoint to the oAuth server. | [optional] -**oAuthTokenType** | **String** | Token type for the oAuth config. | [optional] - - - diff --git a/docs/Nrtfv1webhookswebhookIdreplaysByDeliveryStatus.md b/docs/Nrtfv1webhookswebhookIdreplaysByDeliveryStatus.md deleted file mode 100644 index c312cf4c9..000000000 --- a/docs/Nrtfv1webhookswebhookIdreplaysByDeliveryStatus.md +++ /dev/null @@ -1,15 +0,0 @@ - -# Nrtfv1webhookswebhookIdreplaysByDeliveryStatus - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **String** | The status of the webhook. Options are FAILED or RETRY | [optional] -**startTime** | [**DateTime**](DateTime.md) | The start time in yyyy-mm-dd hh:mm:ss.ms format. Maximum value is 1 month prior to todays system time. The difference between Start Time and End Time cannot exceed a 24 hour window within the last month. | [optional] -**endTime** | [**DateTime**](DateTime.md) | The end time in yyyy-mm-dd hh:mm:ss.ms format. The difference between Start Time and End Time cannot exceed a 24 hour window within the last month. | [optional] -**hoursBack** | **Integer** | Alternative parameter to startTime/endTime. It evaluates the startTime using the current system time (endTime) and the hoursBack value (default = 24hrs). | [optional] -**productId** | **String** | | [optional] -**eventType** | **String** | | [optional] - - - diff --git a/docs/PaymentsStrongAuthIssuerInformation.md b/docs/PaymentsStrongAuthIssuerInformation.md index bf5a3d920..5fb999d27 100644 --- a/docs/PaymentsStrongAuthIssuerInformation.md +++ b/docs/PaymentsStrongAuthIssuerInformation.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **lowValueExemptionResult** | **String** | This will be the value returned by Visanet when low value exemption has been requested. Valid values: Visa Platform Connect - `2` Low value exemption validated/honored - `3` Low value exemption failed validation/not honored | [optional] **secureCorporatePaymentResult** | **String** | This will be the value returned by Visanet when secure corporate payment (scp) exemption has been requested. Valid values: Visa Platform Connect - `2` Secure corporate payment exemption validated/honored - `3` Secure corporate payment exemption failed validation/not honored | [optional] **transactionRiskAnalysisExemptionResult** | **String** | This will be the value returned by Visanet when transaction risk analysis (TRA) exemption has been requested. Valid values: Visa Platform Connect - `2` transaction risk analysis (TRA) exemption validated/honored - `3` transaction risk analysis (TRA) exemption failed validation/not honored | [optional] +**delegatedAuthenticationResult** | **String** | This will be the value returned by Visanet when delegated authentication has been requested. | [optional] diff --git a/docs/PtsV2PaymentsPost201Response1.md b/docs/PtsV2PaymentsPost201Response1.md index 2433ead96..70a8563a8 100644 --- a/docs/PtsV2PaymentsPost201Response1.md +++ b/docs/PtsV2PaymentsPost201Response1.md @@ -12,6 +12,8 @@ Name | Type | Description | Notes **paymentInformation** | [**PtsV2PaymentsPost201Response1PaymentInformation**](PtsV2PaymentsPost201Response1PaymentInformation.md) | | [optional] **orderInformation** | [**PtsV2PaymentsPost201Response1OrderInformation**](PtsV2PaymentsPost201Response1OrderInformation.md) | | [optional] **clientReferenceInformation** | [**PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation**](PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation.md) | | [optional] +**issuerInformation** | [**PtsV2PaymentsPost201Response1IssuerInformation**](PtsV2PaymentsPost201Response1IssuerInformation.md) | | [optional] +**errorInformation** | [**PtsV2PaymentsPost201Response1ErrorInformation**](PtsV2PaymentsPost201Response1ErrorInformation.md) | | [optional] diff --git a/docs/PtsV2PaymentsPost201Response1ErrorInformation.md b/docs/PtsV2PaymentsPost201Response1ErrorInformation.md new file mode 100644 index 000000000..4afcf1d84 --- /dev/null +++ b/docs/PtsV2PaymentsPost201Response1ErrorInformation.md @@ -0,0 +1,12 @@ + +# PtsV2PaymentsPost201Response1ErrorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **String** | The reason of the status. | [optional] +**message** | **String** | The detail message related to the status and reason listed above. | [optional] +**details** | [**List<PtsV2PaymentsPost201Response1ErrorInformationDetails>**](PtsV2PaymentsPost201Response1ErrorInformationDetails.md) | | [optional] + + + diff --git a/docs/PtsV2PaymentsPost201Response1ErrorInformationDetails.md b/docs/PtsV2PaymentsPost201Response1ErrorInformationDetails.md new file mode 100644 index 000000000..32023c942 --- /dev/null +++ b/docs/PtsV2PaymentsPost201Response1ErrorInformationDetails.md @@ -0,0 +1,10 @@ + +# PtsV2PaymentsPost201Response1ErrorInformationDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **String** | Possible reasons for the error. Possible values: - MISSING_FIELD - INVALID_DATA | [optional] + + + diff --git a/docs/PtsV2PaymentsPost201Response1IssuerInformation.md b/docs/PtsV2PaymentsPost201Response1IssuerInformation.md new file mode 100644 index 000000000..368666c19 --- /dev/null +++ b/docs/PtsV2PaymentsPost201Response1IssuerInformation.md @@ -0,0 +1,11 @@ + +# PtsV2PaymentsPost201Response1IssuerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Name of the card issuer provided by the processor. | [optional] +**code** | **String** | Unique code for card issuer provided by the processor. | [optional] + + + diff --git a/docs/PtsV2PaymentsPost201Response1OrderInformation.md b/docs/PtsV2PaymentsPost201Response1OrderInformation.md index 992a265b2..1596c3f92 100644 --- a/docs/PtsV2PaymentsPost201Response1OrderInformation.md +++ b/docs/PtsV2PaymentsPost201Response1OrderInformation.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **billTo** | [**PtsV2PaymentsPost201Response1OrderInformationBillTo**](PtsV2PaymentsPost201Response1OrderInformationBillTo.md) | | [optional] **shipTo** | [**PtsV2PaymentsPost201Response1OrderInformationShipTo**](PtsV2PaymentsPost201Response1OrderInformationShipTo.md) | | [optional] +**amountDetails** | [**PtsV2PaymentsPost201Response1OrderInformationAmountDetails**](PtsV2PaymentsPost201Response1OrderInformationAmountDetails.md) | | [optional] diff --git a/docs/PtsV2PaymentsPost201Response1OrderInformationAmountDetails.md b/docs/PtsV2PaymentsPost201Response1OrderInformationAmountDetails.md new file mode 100644 index 000000000..b7482e8ad --- /dev/null +++ b/docs/PtsV2PaymentsPost201Response1OrderInformationAmountDetails.md @@ -0,0 +1,10 @@ + +# PtsV2PaymentsPost201Response1OrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**refundBalance** | **String** | This field will carry the remaning amount which can be refunded. | [optional] + + + diff --git a/docs/PtsV2PaymentsPost201Response1PaymentInformation.md b/docs/PtsV2PaymentsPost201Response1PaymentInformation.md index 36599f28b..1454b904a 100644 --- a/docs/PtsV2PaymentsPost201Response1PaymentInformation.md +++ b/docs/PtsV2PaymentsPost201Response1PaymentInformation.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **paymentType** | [**PtsV2PaymentsPost201Response1PaymentInformationPaymentType**](PtsV2PaymentsPost201Response1PaymentInformationPaymentType.md) | | [optional] +**eWallet** | [**PtsV2PaymentsPost201Response1PaymentInformationEWallet**](PtsV2PaymentsPost201Response1PaymentInformationEWallet.md) | | [optional] **customer** | [**Ptsv2refreshpaymentstatusidPaymentInformationCustomer**](Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md) | | [optional] **bank** | [**PtsV2PaymentsPost201Response1PaymentInformationBank**](PtsV2PaymentsPost201Response1PaymentInformationBank.md) | | [optional] diff --git a/docs/PtsV2PaymentsPost201Response1PaymentInformationEWallet.md b/docs/PtsV2PaymentsPost201Response1PaymentInformationEWallet.md new file mode 100644 index 000000000..45e9357e1 --- /dev/null +++ b/docs/PtsV2PaymentsPost201Response1PaymentInformationEWallet.md @@ -0,0 +1,11 @@ + +# PtsV2PaymentsPost201Response1PaymentInformationEWallet + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Valid Values: - CreditCard - BankTransfer - MobileTransfer - KakaoMoney - NaverPayPoint | [optional] +**fundingSource** | **String** | Valid Values: - PAYCO - Kakaopay - NaverPay - SSG Pay - L.Pay - Apple Pay - TOSS Pay - Samsung Pay | [optional] + + + diff --git a/docs/PtsV2PaymentsPost201Response1ProcessorInformation.md b/docs/PtsV2PaymentsPost201Response1ProcessorInformation.md index 2e5c616d6..e71fa80a7 100644 --- a/docs/PtsV2PaymentsPost201Response1ProcessorInformation.md +++ b/docs/PtsV2PaymentsPost201Response1ProcessorInformation.md @@ -7,6 +7,8 @@ Name | Type | Description | Notes **transactionId** | **String** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] **tradeNumber** | **String** | The description for this field is not available. | [optional] **rawResponse** | **String** | This field is set to the value of failure reason returned by the processor. | [optional] +**rawResponseLocal** | **String** | This field is set to the value of failure reason returned by the processor in the local language of the processor. | [optional] +**responseDetails** | **String** | This field might contain information about a decline. | [optional] **responseCode** | **String** | This field is set to the value of response code returned by the processor. | [optional] **sellerProtection** | [**PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection**](PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection.md) | | [optional] **avs** | [**PtsV2PaymentsPost201Response1ProcessorInformationAvs**](PtsV2PaymentsPost201Response1ProcessorInformationAvs.md) | | [optional] diff --git a/docs/PtsV2PaymentsRefundPost201Response.md b/docs/PtsV2PaymentsRefundPost201Response.md index ac015dd5c..d3e5f0279 100644 --- a/docs/PtsV2PaymentsRefundPost201Response.md +++ b/docs/PtsV2PaymentsRefundPost201Response.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **reconciliationId** | **String** | Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. | [optional] **clientReferenceInformation** | [**PtsV2PaymentsRefundPost201ResponseClientReferenceInformation**](PtsV2PaymentsRefundPost201ResponseClientReferenceInformation.md) | | [optional] **refundAmountDetails** | [**PtsV2PaymentsRefundPost201ResponseRefundAmountDetails**](PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md) | | [optional] +**processingInformation** | [**PtsV2PaymentsCapturesPost201ResponseProcessingInformation**](PtsV2PaymentsCapturesPost201ResponseProcessingInformation.md) | | [optional] **processorInformation** | [**PtsV2PaymentsRefundPost201ResponseProcessorInformation**](PtsV2PaymentsRefundPost201ResponseProcessorInformation.md) | | [optional] **orderInformation** | [**PtsV2PaymentsRefundPost201ResponseOrderInformation**](PtsV2PaymentsRefundPost201ResponseOrderInformation.md) | | [optional] **pointOfSaleInformation** | [**PtsV2PaymentsCapturesPost201ResponsePointOfSaleInformation**](PtsV2PaymentsCapturesPost201ResponsePointOfSaleInformation.md) | | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformation.md b/docs/Ptsv2paymentsProcessingInformation.md index 0ebdd6ecc..260fdf857 100644 --- a/docs/Ptsv2paymentsProcessingInformation.md +++ b/docs/Ptsv2paymentsProcessingInformation.md @@ -43,7 +43,7 @@ Name | Type | Description | Notes **enablerId** | **String** | Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers. | [optional] **processingInstruction** | **String** | The instruction to process an order. - default value: 'NO_INSTRUCTION' - 'ORDER_SAVED_EXPLICITLY' | [optional] **transactionTypeIndicator** | **String** | This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only. Possible values: - 201- Mastercard Rebate - 202- rePower Load Value - 203- Gaming Re-pay - 204- General Person-to-Person - 205- General Transfer to Own Account - 206- Agent Cash Out - 207- Payment of Own Credit Card Bill - 208- Business Disbursement - 209- Government/Non-Profit Disbursement - 210- Rapid Merchant Settlement - 211- Cash in at ATM (Usage limited to specific countries) - 212- Cash in at Point of Sale (Usage limited to specific countries) - 213- General Business to Business Transfer - 214- Mastercard Merchant Presented QR - 215- Mastercard Merchant Presented QR Refund Payment - 216- Utility Payments (for Brazil domestic use only) - 217- Government Services (for Brazil domestic use only) - 218- Mobile phone top-ups (for Brazil domestic use only) - 219- Coupon booklet payments (for Brazil domestic use only) - 220- General Person-to-Person Transfer - 221- Person-to-Person Transfer to Card Account - 222- General Transfer to Own Account - 223- Agent Cash Out - 224- Payment of Own Credit Card Bill - 225- Business Disbursement - 226- Transfer to Own Staged Digital Wallet Account - 227- Transfer to Own Debit or Prepaid Account - 228- General Business-to-Business Transfer - 229- Installment-based repayment - 230- Mastercard ATM Cash Pick-Up Transaction - 231- Cryptocurrency - 232- High-risk Securities | [optional] -**purposeOfPayment** | **String** | Possible values: - `16` : High Risk Security Other values can also be accommodated in future for different transactions. Currently this field is only used in OCT, we could not find any existing valid values for the past 30 days in production. Issuer may decline invalid purpose of payment code with response code 93. This field is also applicable for AFT transactions. For list of supported values, please refer to Developer Guide. | [optional] +**purposeOfPayment** | **String** | This field is applicable for AFT and OCT transactions. For list of supported values, please refer to Developer Guide. | [optional] **languageCode** | **String** | Contains the ISO 639-2 defined language Code | [optional] **originalPaymentId** | **String** | This value is used for linking Authorization extension transaction to the original Authorization transaction and for linking MIT (Merchant initiated transaction) with the respective CIT (Customer initiated transaction). | [optional] diff --git a/docs/Ptsv2payoutsProcessingInformation.md b/docs/Ptsv2payoutsProcessingInformation.md index 5c141c7e2..46a8945d6 100644 --- a/docs/Ptsv2payoutsProcessingInformation.md +++ b/docs/Ptsv2payoutsProcessingInformation.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] **payoutsOptions** | [**Ptsv2payoutsProcessingInformationPayoutsOptions**](Ptsv2payoutsProcessingInformationPayoutsOptions.md) | | [optional] **transactionReason** | **String** | Transaction reason code. | [optional] -**purposeOfPayment** | **String** | This will send purpose of funds code for original credit transactions (OCTs). | [optional] +**purposeOfPayment** | **String** | This field is applicable for AFT and OCT transactions. For list of supported values, please refer to Developer Guide. | [optional] **fundingOptions** | [**Ptsv2payoutsProcessingInformationFundingOptions**](Ptsv2payoutsProcessingInformationFundingOptions.md) | | [optional] **languageCode** | **String** | Contains the ISO 639-2 defined language Code | [optional] **purchaseOptions** | [**Ptsv2payoutsProcessingInformationPurchaseOptions**](Ptsv2payoutsProcessingInformationPurchaseOptions.md) | | [optional] diff --git a/docs/Ptsv2payoutsRecipientInformation.md b/docs/Ptsv2payoutsRecipientInformation.md index c9e826af7..a991ae017 100644 --- a/docs/Ptsv2payoutsRecipientInformation.md +++ b/docs/Ptsv2payoutsRecipientInformation.md @@ -4,13 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**firstName** | **String** | First name of recipient. characters. * CTV (14) * Paymentech (30) | [optional] -**middleName** | **String** | Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] -**lastName** | **String** | Last name of recipient. characters. * CTV (14) * Paymentech (30) | [optional] -**address1** | **String** | Recipient address information. Required only for FDCCompass. | [optional] -**locality** | **String** | Recipient city. Required only for FDCCompass. | [optional] -**administrativeArea** | **String** | Recipient State. Required only for FDCCompass. | [optional] -**country** | **String** | Recipient country code. Required only for FDCCompass. | [optional] +**firstName** | **String** | First name of the recipient. This field is applicable for AFT & OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional] +**middleName** | **String** | Middle name of the recipient. This field is applicable for AFT & OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional] +**lastName** | **String** | Last name of the recipient. This field is applicable for AFT & OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional] +**address1** | **String** | The street address of the recipient This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. | [optional] +**locality** | **String** | The city of the recipient. This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. | [optional] +**administrativeArea** | **String** | The state or province of the recipient. This field is applicable for AFT and OCT transactions when the recipient country is US or CA. Else it is optional. Must be a two character value | [optional] +**country** | **String** | The country associated with the address of the recipient. This field is applicable for AFT and OCT transactions. Must be a two character ISO country code. For example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) | [optional] **postalCode** | **String** | Recipient postal code. Required only for FDCCompass. | [optional] **phoneNumber** | **String** | Recipient phone number. Required only for FDCCompass. | [optional] **aliasName** | **String** | Account owner alias name. | [optional] diff --git a/docs/Ptsv2payoutsSenderInformation.md b/docs/Ptsv2payoutsSenderInformation.md index 79985ff22..9b6a99a02 100644 --- a/docs/Ptsv2payoutsSenderInformation.md +++ b/docs/Ptsv2payoutsSenderInformation.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **referenceNumber** | **String** | Reference number generated by you that uniquely identifies the sender. | [optional] **account** | [**Ptsv2payoutsSenderInformationAccount**](Ptsv2payoutsSenderInformationAccount.md) | | [optional] -**firstName** | **String** | First name of sender (Optional). * CTV (14) * Paymentech (30) | [optional] +**firstName** | **String** | First name of the sender. This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported.Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to the processor. | [optional] **middleInitial** | **String** | Recipient middle initial (Optional). | [optional] -**middleName** | **String** | Sender's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] -**lastName** | **String** | Recipient last name (Optional). * CTV (14) * Paymentech (30) | [optional] +**middleName** | **String** | Middle name of the sender. This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional] +**lastName** | **String** | Last name of the sender. This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional] **name** | **String** | Name of sender. **Funds Disbursement** This value is the name of the originator sending the funds disbursement. * CTV, Paymentech (30) | [optional] **address1** | **String** | Street address of sender. **Funds Disbursement** This value is the address of the originator sending the funds disbursement. | [optional] **locality** | **String** | City of sender. **Funds Disbursement** This value is the city of the originator sending the funds disbursement. | [optional] diff --git a/docs/Ptsv2payoutsSenderInformationAccount.md b/docs/Ptsv2payoutsSenderInformationAccount.md index 4bcad01f1..61b279203 100644 --- a/docs/Ptsv2payoutsSenderInformationAccount.md +++ b/docs/Ptsv2payoutsSenderInformationAccount.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fundsSource** | **String** | Source of funds. Possible values: Paymentech, CTV, FDC Compass: - 01: Credit card - 02: Debit card - 03: Prepaid card Paymentech, CTV - - 04: Cash - 05: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings accounts, and proprietary debit or ATM cards. - 06: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines of credit. FDCCompass - - 04: Deposit Account **Funds Disbursement** This value is most likely 05 to identify that the originator used a deposit account to fund the disbursement. **Credit Card Bill Payment** This value must be 02, 03, 04, or 05. | [optional] -**number** | **String** | The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number. **Funds disbursements** This field is optional. **All other transactions** This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: * FDCCompass (<= 19) * Paymentech (<= 16) | [optional] +**number** | **String** | The account number of the entity funding the transaction. It is the sender's account number. It can be a debit/credit card account number or bank account number. **Funds disbursements and OCT transactions** This field is optional. **All other transactions** This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: * FDCCompass (<= 19) * Paymentech (<= 16) | [optional] diff --git a/docs/ReplayWebhooksApi.md b/docs/ReplayWebhooksApi.md deleted file mode 100644 index a1e22c6a8..000000000 --- a/docs/ReplayWebhooksApi.md +++ /dev/null @@ -1,55 +0,0 @@ -# ReplayWebhooksApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**replayPreviousWebhooks**](ReplayWebhooksApi.md#replayPreviousWebhooks) | **POST** /nrtf/v1/webhooks/{webhookId}/replays | Replay Previous Webhooks - - - -# **replayPreviousWebhooks** -> replayPreviousWebhooks(webhookId, replayWebhooksRequest) - -Replay Previous Webhooks - -Initiate a webhook replay request to replay transactions that happened in the past. Cannot execute more than 1 replay request at a time. While one request is processing, you will not be allowed to execute another replay. The difference between Start and End time cannot exceed a 24 hour window, and 1 month is the farthest date back that is eligible for replay. - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.ReplayWebhooksApi; - - -ReplayWebhooksApi apiInstance = new ReplayWebhooksApi(); -String webhookId = "webhookId_example"; // String | The webhook uuid identifier. -ReplayWebhooksRequest replayWebhooksRequest = new ReplayWebhooksRequest(); // ReplayWebhooksRequest | The request query -try { - apiInstance.replayPreviousWebhooks(webhookId, replayWebhooksRequest); -} catch (ApiException e) { - System.err.println("Exception when calling ReplayWebhooksApi#replayPreviousWebhooks"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **webhookId** | **String**| The webhook uuid identifier. | - **replayWebhooksRequest** | [**ReplayWebhooksRequest**](ReplayWebhooksRequest.md)| The request query | [optional] - -### Return type - -null (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - diff --git a/docs/ReplayWebhooksRequest.md b/docs/ReplayWebhooksRequest.md deleted file mode 100644 index b7b98e2cc..000000000 --- a/docs/ReplayWebhooksRequest.md +++ /dev/null @@ -1,11 +0,0 @@ - -# ReplayWebhooksRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**byTransactionTraceIdentifiers** | **List<String>** | | [optional] -**byDeliveryStatus** | [**Nrtfv1webhookswebhookIdreplaysByDeliveryStatus**](Nrtfv1webhookswebhookIdreplaysByDeliveryStatus.md) | | [optional] - - - diff --git a/docs/SaveAsymEgressKey.md b/docs/SaveAsymEgressKey.md index 98303efac..ecd48f25a 100644 --- a/docs/SaveAsymEgressKey.md +++ b/docs/SaveAsymEgressKey.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **clientReferenceInformation** | [**Kmsegressv2keysasymClientReferenceInformation**](Kmsegressv2keysasymClientReferenceInformation.md) | | [optional] -**clientRequestAction** | **String** | Client request action. | -**keyInformation** | [**Kmsegressv2keysasymKeyInformation**](Kmsegressv2keysasymKeyInformation.md) | | +**clientRequestAction** | **String** | Client request action. | [optional] +**keyInformation** | [**Kmsegressv2keysasymKeyInformation**](Kmsegressv2keysasymKeyInformation.md) | | [optional] diff --git a/docs/SaveSymEgressKey.md b/docs/SaveSymEgressKey.md index 645a62a69..3eae28ce0 100644 --- a/docs/SaveSymEgressKey.md +++ b/docs/SaveSymEgressKey.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **clientReferenceInformation** | [**Kmsegressv2keyssymClientReferenceInformation**](Kmsegressv2keyssymClientReferenceInformation.md) | | [optional] -**clientRequestAction** | **String** | Client request action. | -**keyInformation** | [**Kmsegressv2keyssymKeyInformation**](Kmsegressv2keyssymKeyInformation.md) | | +**clientRequestAction** | **String** | Client request action. | [optional] +**keyInformation** | [**Kmsegressv2keyssymKeyInformation**](Kmsegressv2keyssymKeyInformation.md) | | [optional] diff --git a/docs/TransactionBatchesApi.md b/docs/TransactionBatchesApi.md index a55be9dc2..8df3bcd18 100644 --- a/docs/TransactionBatchesApi.md +++ b/docs/TransactionBatchesApi.md @@ -7,6 +7,7 @@ Method | HTTP request | Description [**getTransactionBatchDetails**](TransactionBatchesApi.md#getTransactionBatchDetails) | **GET** /pts/v1/transaction-batch-details/{id} | Get Transaction Details for a given Batch Id [**getTransactionBatchId**](TransactionBatchesApi.md#getTransactionBatchId) | **GET** /pts/v1/transaction-batches/{id} | Get Individual Batch File [**getTransactionBatches**](TransactionBatchesApi.md#getTransactionBatches) | **GET** /pts/v1/transaction-batches | Get a List of Batch Files +[**uploadTransactionBatch**](TransactionBatchesApi.md#uploadTransactionBatch) | **POST** /pts/v1/transaction-batch-upload | Upload a Batch File @@ -149,3 +150,47 @@ No authorization required - **Content-Type**: application/json;charset=utf-8 - **Accept**: application/hal+json + +# **uploadTransactionBatch** +> uploadTransactionBatch(file) + +Upload a Batch File + +This endpoint enables the upload of a batch file containing transactions for processing. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.TransactionBatchesApi; + + +TransactionBatchesApi apiInstance = new TransactionBatchesApi(); +File file = new File("/path/to/file.txt"); // File | The file to upload. +try { + apiInstance.uploadTransactionBatch(file); +} catch (ApiException e) { + System.err.println("Exception when calling TransactionBatchesApi#uploadTransactionBatch"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | **File**| The file to upload. | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md index ecf113101..7afd79e44 100644 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **country** | **String** | This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer. | [optional] **binLength** | **String** | This field contains the length of the BIN. | [optional] **phoneNumber** | **String** | This field contains the customer service phone number for the issuer. | [optional] +**transactionInformation** | **String** | In a Mastercard Transaction, this field contains the unique identifier (Transaction Link ID) for the first transaction in a transaction life cycle. This ID is crucial for maintaining continuity and linking subsequent operations to the original transaction. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md index 51a957316..1931538d0 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **processor** | [**TssV2TransactionsGet200ResponseProcessorInformationProcessor**](TssV2TransactionsGet200ResponseProcessorInformationProcessor.md) | | [optional] +**providerTransactionId** | **String** | Unique ID [codigo] generated by the processor for real-time payments processed directly by the Iugu processor. | [optional] **approvalCode** | **String** | Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. | [optional] **retrievalReferenceNumber** | **String** | #### Ingenico ePayments Unique number that CyberSource generates to identify the transaction. You can use this value to identify transactions in the Ingenico ePayments Collections Report, which provides settlement information. Contact customer support for information about the report. ### CyberSource through VisaNet Retrieval request number. | [optional] diff --git a/docs/UpdateWebhookRequest.md b/docs/UpdateWebhookRequest.md deleted file mode 100644 index 68c8f5c4c..000000000 --- a/docs/UpdateWebhookRequest.md +++ /dev/null @@ -1,21 +0,0 @@ - -# UpdateWebhookRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | Client friendly webhook name. | [optional] -**description** | **String** | Client friendly webhook description.\\ | [optional] -**organizationId** | **String** | Organization Id. | [optional] -**productId** | **String** | The product you are receiving a webhook for. | [optional] -**eventTypes** | **List<String>** | Array of the different events for a given product id. | [optional] -**webhookUrl** | **String** | The client's endpoint (URL) to receive webhooks. | [optional] -**healthCheckUrl** | **String** | The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. | [optional] -**status** | **String** | Webhook status. | [optional] -**notificationScope** | [**Notificationsubscriptionsv1webhooksNotificationScope**](Notificationsubscriptionsv1webhooksNotificationScope.md) | | [optional] -**retryPolicy** | [**Notificationsubscriptionsv1webhooksRetryPolicy**](Notificationsubscriptionsv1webhooksRetryPolicy.md) | | [optional] -**securityPolicy** | [**Notificationsubscriptionsv1webhooksSecurityPolicy**](Notificationsubscriptionsv1webhooksSecurityPolicy.md) | | [optional] -**additionalAttributes** | [**List<Map<String, String>>**](Map.md) | Additional, free form configuration data. | [optional] - - - diff --git a/generator/cybersource-java-template/libraries/okhttp-gson/ApiClient.mustache b/generator/cybersource-java-template/libraries/okhttp-gson/ApiClient.mustache index 16548d116..b7d6a6bb8 100644 --- a/generator/cybersource-java-template/libraries/okhttp-gson/ApiClient.mustache +++ b/generator/cybersource-java-template/libraries/okhttp-gson/ApiClient.mustache @@ -57,6 +57,7 @@ import okhttp3.Route; import okhttp3.internal.http.HttpMethod; import okhttp3.logging.HttpLoggingInterceptor; import okhttp3.logging.HttpLoggingInterceptor.Level; +import okio.Buffer; import okio.BufferedSink; import okio.Okio; import org.bouncycastle.jce.provider.BouncyCastleProvider; @@ -516,7 +517,6 @@ public class ApiClient { *

* When lenientDatetimeFormat is enabled, the following ISO 8601 datetime * formats are supported: - *

*