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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 12 additions & 16 deletions docs/PlansApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Method | HTTP request | Description

<a name="activatePlan"></a>
# **activatePlan**
> InlineResponse2004 activatePlan(id, activatePlanRequest)
> InlineResponse2004 activatePlan(id)

Activate a Plan

Expand All @@ -31,9 +31,8 @@ Activate a Plan

PlansApi apiInstance = new PlansApi();
String id = "id_example"; // String | Plan Id
Object activatePlanRequest = null; // Object |
try {
InlineResponse2004 result = apiInstance.activatePlan(id, activatePlanRequest);
InlineResponse2004 result = apiInstance.activatePlan(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PlansApi#activatePlan");
Expand All @@ -46,7 +45,6 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Plan Id |
**activatePlanRequest** | **Object**| | [optional]

### Return type

Expand All @@ -59,7 +57,7 @@ No authorization required
### HTTP request headers

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

<a name="createPlan"></a>
# **createPlan**
Expand Down Expand Up @@ -104,11 +102,11 @@ No authorization required
### HTTP request headers

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

<a name="deactivatePlan"></a>
# **deactivatePlan**
> InlineResponse2004 deactivatePlan(id, deactivatePlanRequest)
> InlineResponse2004 deactivatePlan(id)

Deactivate a Plan

Expand All @@ -123,9 +121,8 @@ Deactivate a Plan

PlansApi apiInstance = new PlansApi();
String id = "id_example"; // String | Plan Id
Object deactivatePlanRequest = null; // Object |
try {
InlineResponse2004 result = apiInstance.deactivatePlan(id, deactivatePlanRequest);
InlineResponse2004 result = apiInstance.deactivatePlan(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PlansApi#deactivatePlan");
Expand All @@ -138,7 +135,6 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Plan Id |
**deactivatePlanRequest** | **Object**| | [optional]

### Return type

Expand All @@ -151,7 +147,7 @@ No authorization required
### HTTP request headers

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

<a name="deletePlan"></a>
# **deletePlan**
Expand Down Expand Up @@ -196,7 +192,7 @@ No authorization required
### HTTP request headers

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

<a name="getPlan"></a>
# **getPlan**
Expand Down Expand Up @@ -241,7 +237,7 @@ No authorization required
### HTTP request headers

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

<a name="getPlanCode"></a>
# **getPlanCode**
Expand Down Expand Up @@ -282,7 +278,7 @@ No authorization required
### HTTP request headers

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

<a name="getPlans"></a>
# **getPlans**
Expand Down Expand Up @@ -335,7 +331,7 @@ No authorization required
### HTTP request headers

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

<a name="updatePlan"></a>
# **updatePlan**
Expand Down Expand Up @@ -382,5 +378,5 @@ No authorization required
### HTTP request headers

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

1 change: 1 addition & 0 deletions docs/PtsV2PaymentsPost201Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Name | Type | Description | Notes
**buyerInformation** | [**PtsV2PaymentsPost201ResponseBuyerInformation**](PtsV2PaymentsPost201ResponseBuyerInformation.md) | | [optional]
**riskInformation** | [**PtsV2PaymentsPost201ResponseRiskInformation**](PtsV2PaymentsPost201ResponseRiskInformation.md) | | [optional]
**consumerAuthenticationInformation** | [**PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation**](PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md) | | [optional]
**embeddedActions** | [**PtsV2PaymentsPost201ResponseEmbeddedActions**](PtsV2PaymentsPost201ResponseEmbeddedActions.md) | | [optional]
**watchlistScreeningInformation** | [**PtsV2PaymentsPost201ResponseWatchlistScreeningInformation**](PtsV2PaymentsPost201ResponseWatchlistScreeningInformation.md) | | [optional]


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

# PtsV2PaymentsPost201ResponseEmbeddedActions

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CAPTURE** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE**](PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE.md) | | [optional]
**DECISION** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION**](PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION.md) | | [optional]
**CONSUMER_AUTHENTICATION** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION**](PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.md) | | [optional]
**VALIDATE_CONSUMER_AUTHENTICATION** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION**](PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.md) | | [optional]
**WATCHLIST_SCREENING** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING**](PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING.md) | | [optional]



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

# PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **String** | The status of the submitted transaction. Possible values: - PENDING | [optional]
**reason** | **String** | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_MERCHANT_CONFIGURATION - EXCEEDS_AUTH_AMOUNT - AUTH_ALREADY_REVERSED - TRANSACTION_ALREADY_SETTLED - INVALID_AMOUNT - MISSING_AUTH - TRANSACTION_ALREADY_REVERSED_OR_SETTLED - NOT_SUPPORTED | [optional]
**message** | **String** | The detail message related to the status and reason listed above. | [optional]



Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

# PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **String** | The status for payerAuthentication 201 enroll and validate calls. Possible values are: - &#x60;AUTHENTICATION_SUCCESSFUL&#x60; - &#x60;PENDING_AUTHENTICATION&#x60; - &#x60;INVALID_REQUEST&#x60; - &#x60;AUTHENTICATION_FAILED&#x60; | [optional]
**reason** | **String** | The reason of the status. Possible values are: - &#x60;INVALID_MERCHANT_CONFIGURATION&#x60; - &#x60;CONSUMER_AUTHENTICATION_REQUIRED&#x60; - &#x60;CONSUMER_AUTHENTICATION_FAILED&#x60; - &#x60;AUTHENTICATION_FAILED&#x60; | [optional]
**message** | **String** | The message describing the reason of the status. Value is: - Encountered a Payer Authentication problem. Payer could not be authenticated. | [optional]



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

# PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **String** | The status of the submitted transaction. Possible values: - &#x60;ACCEPTED&#x60; - &#x60;REJECTED&#x60; - &#x60;PENDING_REVIEW&#x60; - &#x60;DECLINED&#x60; - &#x60;PENDING_AUTHENTICATION&#x60; - &#x60;INVALID_REQUEST&#x60; - &#x60;AUTHENTICATION_FAILED&#x60; - &#x60;CHALLENGE&#x60; | [optional]
**reason** | **String** | The reason of the status. Possible values: - &#x60;EXPIRED_CARD&#x60; - &#x60;SCORE_EXCEEDS_THRESHOLD&#x60; - &#x60;DECISION_PROFILE_REVIEW&#x60; - &#x60;DECISION_PROFILE_REJECT&#x60; - &#x60;CONSUMER_AUTHENTICATION_REQUIRED&#x60; - &#x60;INVALID_MERCHANT_CONFIGURATION&#x60; - &#x60;CONSUMER_AUTHENTICATION_FAILED&#x60; - &#x60;DECISION_PROFILE_CHALLENGE&#x60; - &#x60;CUSTOMER_WATCHLIST_MATCH&#x60; - &#x60;ADDRESS_COUNTRY_WATCHLIST_MATCH&#x60; - &#x60;EMAIL_COUNTRY_WATCHLIST_MATCH&#x60; - &#x60;IP_COUNTRY_WATCHLIST_MATCH&#x60; | [optional]
**message** | **String** | The detail message related to the status and reason listed above. | [optional]



Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

# PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **String** | The status for the call can be: - COMPLETED - INVALID_REQUEST - DECLINED | [optional]
**reason** | **String** | The reason of the status. Value can be - &#x60;CUSTOMER_WATCHLIST_MATCH&#x60; - &#x60;ADDRESS_COUNTRY_WATCHLIST_MATCH&#x60; - &#x60;EMAIL_COUNTRY_WATCHLIST_MATCH&#x60; - &#x60;IP_COUNTRY_WATCHLIST_MATCH&#x60; - &#x60;INVALID_MERCHANT_CONFIGURATION&#x60; | [optional]
**message** | **String** | The message describing the reason of the status. Value can be - The customer matched the Denied Parties List - The Export bill_country/ship_country match - Export email_country match - Export hostname_country/ip_country match | [optional]



2 changes: 1 addition & 1 deletion docs/Ptsv2paymentsProcessingInformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**actionList** | **List&lt;String&gt;** | Array of actions (one or more) to be included in the payment to invoke bundled services along with payment. Possible values are one or more of follows: - &#x60;DECISION_SKIP&#x60;: Use this when you want to skip Decision Manager service(s). - &#x60;TOKEN_CREATE&#x60;: Use this when you want to create a token from the card/bank data in your payment request. - &#x60;CONSUMER_AUTHENTICATION&#x60;: Use this when you want to check if a card is enrolled in Payer Authentioncation along with your payment request. - &#x60;VALIDATE_CONSUMER_AUTHENTICATION&#x60;: Use this after you acquire a Payer Authentioncation result that needs to be included for your payment request. - &#x60;AP_INITIATE&#x60;: Use this when Alternative Payment Initiate service is requested. - &#x60;WATCHLIST_SCREENING&#x60; : Use this when you want to call Watchlist Screening service. | [optional]
**actionList** | **List&lt;String&gt;** | Array of actions (one or more) to be included in the payment to invoke bundled services along with payment. Possible values are one or more of follows: - &#x60;DECISION_SKIP&#x60;: Use this when you want to skip Decision Manager service(s). - &#x60;TOKEN_CREATE&#x60;: Use this when you want to create a token from the card/bank data in your payment request. - &#x60;CONSUMER_AUTHENTICATION&#x60;: Use this when you want to check if a card is enrolled in Payer Authentication along with your payment request. - &#x60;VALIDATE_CONSUMER_AUTHENTICATION&#x60;: Use this after you acquire a Payer Authentication result that needs to be included for your payment request. - &#x60;AP_INITIATE&#x60;: Use this when Alternative Payment Initiate service is requested. - &#x60;WATCHLIST_SCREENING&#x60; : Use this when you want to call Watchlist Screening service. | [optional]
**enableEscrowOption** | **Boolean** | Indicates whether to use the customer’s escrow agreement. Possible values: - &#x60;true&#x60;: yes, use the customer’s escrow agreement. - &#x60;false&#x60;: no, do not use the customer’s escrow agreement. | [optional]
**actionTokenTypes** | **List&lt;String&gt;** | CyberSource tokens types you are performing a create on. If not supplied the default token type for the merchants token vault will be used. Valid values: - customer - paymentInstrument - instrumentIdentifier - shippingAddress | [optional]
**binSource** | **String** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/Ptsv2paymentsRecipientInformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**lastName** | **String** | Recipient’s last 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. For details, see the &#x60;recipient_lastname&#x60; field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [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. For details, see the &#x60;recipient_middlename&#x60; field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
**postalCode** | **String** | Partial postal code for the recipient’s address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, 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. For details, see the &#x60;recipient_postal_code&#x60; field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
**dateOfBirth** | **String** | Recipient’s date of birth. **Format**: &#x60;YYYYMMDD&#x60;. This field is a &#x60;pass-through&#x60;, which means that CyberSource ensures that the value is eight numeric characters but otherwise 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. For more details, see &#x60;recipient_date_of_birth&#x60; field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]



34 changes: 14 additions & 20 deletions docs/SubscriptionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Method | HTTP request | Description

<a name="activateSubscription"></a>
# **activateSubscription**
> InlineResponse2009 activateSubscription(id, activateSubscriptionRequest)
> InlineResponse2009 activateSubscription(id)

Activate a Subscription

Expand All @@ -31,9 +31,8 @@ Activate a &#x60;CANCELLED&#x60; Or &#x60;SUSPENDED&#x60; Subscription

SubscriptionsApi apiInstance = new SubscriptionsApi();
String id = "id_example"; // String | Subscription Id
Object activateSubscriptionRequest = null; // Object |
try {
InlineResponse2009 result = apiInstance.activateSubscription(id, activateSubscriptionRequest);
InlineResponse2009 result = apiInstance.activateSubscription(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SubscriptionsApi#activateSubscription");
Expand All @@ -46,7 +45,6 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Subscription Id |
**activateSubscriptionRequest** | **Object**| | [optional]

### Return type

Expand All @@ -59,11 +57,11 @@ No authorization required
### HTTP request headers

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

<a name="cancelSubscription"></a>
# **cancelSubscription**
> InlineResponse202 cancelSubscription(id, cancelSubscriptionRequest)
> InlineResponse202 cancelSubscription(id)

Cancel a Subscription

Expand All @@ -78,9 +76,8 @@ Cancel a Subscription

SubscriptionsApi apiInstance = new SubscriptionsApi();
String id = "id_example"; // String | Subscription Id
Object cancelSubscriptionRequest = null; // Object |
try {
InlineResponse202 result = apiInstance.cancelSubscription(id, cancelSubscriptionRequest);
InlineResponse202 result = apiInstance.cancelSubscription(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SubscriptionsApi#cancelSubscription");
Expand All @@ -93,7 +90,6 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Subscription Id |
**cancelSubscriptionRequest** | **Object**| | [optional]

### Return type

Expand All @@ -106,7 +102,7 @@ No authorization required
### HTTP request headers

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

<a name="createSubscription"></a>
# **createSubscription**
Expand Down Expand Up @@ -151,7 +147,7 @@ No authorization required
### HTTP request headers

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

<a name="getAllSubscriptions"></a>
# **getAllSubscriptions**
Expand Down Expand Up @@ -202,7 +198,7 @@ No authorization required
### HTTP request headers

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

<a name="getSubscription"></a>
# **getSubscription**
Expand Down Expand Up @@ -247,7 +243,7 @@ No authorization required
### HTTP request headers

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

<a name="getSubscriptionCode"></a>
# **getSubscriptionCode**
Expand Down Expand Up @@ -288,11 +284,11 @@ No authorization required
### HTTP request headers

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

<a name="suspendSubscription"></a>
# **suspendSubscription**
> InlineResponse2021 suspendSubscription(id, suspendSubscriptionRequest)
> InlineResponse2021 suspendSubscription(id)

Suspend a Subscription

Expand All @@ -307,9 +303,8 @@ Suspend a Subscription

SubscriptionsApi apiInstance = new SubscriptionsApi();
String id = "id_example"; // String | Subscription Id
Object suspendSubscriptionRequest = null; // Object |
try {
InlineResponse2021 result = apiInstance.suspendSubscription(id, suspendSubscriptionRequest);
InlineResponse2021 result = apiInstance.suspendSubscription(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SubscriptionsApi#suspendSubscription");
Expand All @@ -322,7 +317,6 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Subscription Id |
**suspendSubscriptionRequest** | **Object**| | [optional]

### Return type

Expand All @@ -335,7 +329,7 @@ No authorization required
### HTTP request headers

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

<a name="updateSubscription"></a>
# **updateSubscription**
Expand Down Expand Up @@ -382,5 +376,5 @@ No authorization required
### HTTP request headers

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

Loading