Skip to content

Commit

Permalink
Merge pull request #137 from CyberSource/release-may-2024
Browse files Browse the repository at this point in the history 
Release May 2024
  • Loading branch information
@monu-kumar-visa
monu-kumar-visa authored Apr 30, 2024
2 parents a94c59b + c87eb2f commit 4902ffb
Show file tree
Hide file tree
Showing 3,423 changed files with 10,658 additions and 6,155 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion docs/ActivateDeactivatePlanResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional]
**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
**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. Returned by Cybersource for all services. | [optional]
**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. Returned by Cybersource for all services. | [optional]
**status** | **String** | The status of the submitted transaction. Possible values: - COMPLETED | [optional]
**planInformation** | [**UpdatePlanResponsePlanInformation**](UpdatePlanResponsePlanInformation.md) | | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/ActivateSubscriptionResponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional]
**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
**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. Returned by Cybersource for all services. | [optional]
**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. Returned by Cybersource for all services. | [optional]
**status** | **String** | The status of the submitted transaction. Possible values: - COMPLETED | [optional]
**subscriptionInformation** | [**ActivateSubscriptionResponseSubscriptionInformation**](ActivateSubscriptionResponseSubscriptionInformation.md) | | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/ActivateSubscriptionResponseSubscriptionInformation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **String** | Subscription code. | [optional]
**status** | **String** | Subscription Status: - `ACTIVE` | [optional]
**status** | **String** | Subscription Status: - `ACTIVE` | [optional]


4 changes: 2 additions & 2 deletions docs/AsymmetricKeyManagementApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Method | HTTP request | Description
Create one or more PKCS12 keys

'Create one or more PKCS12 keys'
'Create one or more PKCS12 keys'

### Example
```javascript
Expand Down Expand Up @@ -62,7 +62,7 @@ No authorization required
Delete one or more PKCS12 keys

'Delete one or more PKCS12 keys'
'Delete one or more PKCS12 keys'

### Example
```javascript
Expand Down
20 changes: 10 additions & 10 deletions docs/BatchesApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Method | HTTP request | Description

<a name="getBatchReport"></a>
# **getBatchReport**
> InlineResponse2007 getBatchReport(batchId)
> InlineResponse2008 getBatchReport(batchId)
Retrieve a Batch Report

**Get Batch Report**&lt;br&gt;This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates &amp; card type. - Response record information including response code, reason, token ids, masked card number, expiration dates &amp; card type.
**Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates & card type. - Response record information including response code, reason, token ids, masked card number, expiration dates & card type.

### Example
```javascript
Expand Down Expand Up @@ -45,7 +45,7 @@ Name | Type | Description | Notes

### Return type

[**InlineResponse2007**](InlineResponse2007.md)
[**InlineResponse2008**](InlineResponse2008.md)

### Authorization

Expand All @@ -58,11 +58,11 @@ No authorization required

<a name="getBatchStatus"></a>
# **getBatchStatus**
> InlineResponse2006 getBatchStatus(batchId)
> InlineResponse2007 getBatchStatus(batchId)
Retrieve a Batch Status

**Get Batch Status**&lt;br&gt;This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)
**Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)

### Example
```javascript
Expand Down Expand Up @@ -91,7 +91,7 @@ Name | Type | Description | Notes

### Return type

[**InlineResponse2006**](InlineResponse2006.md)
[**InlineResponse2007**](InlineResponse2007.md)

### Authorization

Expand All @@ -104,11 +104,11 @@ No authorization required

<a name="getBatchesList"></a>
# **getBatchesList**
> InlineResponse2005 getBatchesList(opts)
> InlineResponse2006 getBatchesList(opts)
List Batches

**List Batches**&lt;br&gt;This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.
**List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.

### Example
```javascript
Expand Down Expand Up @@ -144,7 +144,7 @@ Name | Type | Description | Notes

### Return type

[**InlineResponse2005**](InlineResponse2005.md)
[**InlineResponse2006**](InlineResponse2006.md)

### Authorization

Expand All @@ -161,7 +161,7 @@ No authorization required
Create a Batch

**Create a Batch**&lt;br&gt;This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. &lt;br&gt; The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.&lt;br&gt;The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report.
**Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report.

### Example
```javascript
Expand Down
2 changes: 1 addition & 1 deletion docs/BillingAgreementsApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Method | HTTP request | Description
Modify a Billing Agreement

#### Standing Instruction: Standing Instruction with or without Token. #### Revoke Mandate: When you revoke a mandate, any pending direct debits linked to that mandate are canceled. No notifications are sent. When you revoke a mandate with no pending direct debits, the Bacs scheme or customer&#39;s bank notify you of any subsequent direct debit events. When you revoke a mandate, you cannot send a direct debit request using the mandate ID. Customer payments cannot be made against a revoked mandate. You can revoke a mandate when the customer: - Requests that you revoke the mandate. - Closes their account with you. Possible revoke mandate status values - - Revoked—the revoke mandate request was successfully processed. - Failed—the revoke mandate request was not accepted. #### Update Mandate: In most cases, the account details of an existing mandate cannot be updated in the Bacs schema, except by creating a new mandate. However, some very limited customer information, like name and address, can be updated to the mandate without needing to revoke it first #### Mandate Status: After the customer signs the mandate, request that the mandate status service verify the mandate status. Possible mandate status values: - Active—the mandate is successfully created. A direct debit can be sent for this mandate ID. - Pending—a pending mandate means the mandate is not yet signed. - Failed—the customer did not authenticate. - Expired—the deadline to create the mandate passed. - Revoked—the mandate is cancelled. #### Paypal Billing Agreement: A billing agreement is set up between PayPal and your customer. When you collect the details of a customer&#39;s billing agreement, you are able to bill that customer without requiring an authorization for each payment. You can bill the customer at the same time you process their PayPal Express checkout order, which simplifies your business processes.
#### Standing Instruction: Standing Instruction with or without Token. #### Revoke Mandate: When you revoke a mandate, any pending direct debits linked to that mandate are canceled. No notifications are sent. When you revoke a mandate with no pending direct debits, the Bacs scheme or customer's bank notify you of any subsequent direct debit events. When you revoke a mandate, you cannot send a direct debit request using the mandate ID. Customer payments cannot be made against a revoked mandate. You can revoke a mandate when the customer: - Requests that you revoke the mandate. - Closes their account with you. Possible revoke mandate status values - - Revoked—the revoke mandate request was successfully processed. - Failed—the revoke mandate request was not accepted. #### Update Mandate: In most cases, the account details of an existing mandate cannot be updated in the Bacs schema, except by creating a new mandate. However, some very limited customer information, like name and address, can be updated to the mandate without needing to revoke it first #### Mandate Status: After the customer signs the mandate, request that the mandate status service verify the mandate status. Possible mandate status values: - Active—the mandate is successfully created. A direct debit can be sent for this mandate ID. - Pending—a pending mandate means the mandate is not yet signed. - Failed—the customer did not authenticate. - Expired—the deadline to create the mandate passed. - Revoked—the mandate is cancelled. #### Paypal Billing Agreement: A billing agreement is set up between PayPal and your customer. When you collect the details of a customer's billing agreement, you are able to bill that customer without requiring an authorization for each payment. You can bill the customer at the same time you process their PayPal Express checkout order, which simplifies your business processes.

### Example
```javascript
Expand Down
4 changes: 2 additions & 2 deletions docs/Boardingv1registrationsOrganizationInformation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Name | Type | Description | Notes
**organizationId** | **String** | | [optional]
**parentOrganizationId** | **String** | This field is required for Organization Types: MERCHANT, TRANSACTING | [optional]
**childOrganizations** | **[String]** | | [optional]
**type** | **String** | Determines the type of organization in the hirarchy that this registration will use to onboard this Organization Possible Values: - &#39;TRANSACTING&#39; - &#39;STRUCTURAL&#39; - &#39;MERCHANT&#39; | [optional]
**status** | **String** | Determines the status that the organization will be after being onboarded Possible Values: - &#39;LIVE&#39; - &#39;TEST&#39; - &#39;DRAFT&#39; | [optional]
**type** | **String** | Determines the type of organization in the hirarchy that this registration will use to onboard this Organization Possible Values: - 'TRANSACTING' - 'STRUCTURAL' - 'MERCHANT' | [optional]
**status** | **String** | Determines the status that the organization will be after being onboarded Possible Values: - 'LIVE' - 'TEST' - 'DRAFT' | [optional]
**configurable** | **Boolean** | This denotes the one organization, with exception to the TRANSACTING types, that is allowed to be used for configuration purposes against products. Eventually this field will be deprecated and all organizations will be allowed for product configuration. | [optional] [default to false]
**businessInformation** | [**Boardingv1registrationsOrganizationInformationBusinessInformation**](Boardingv1registrationsOrganizationInformationBusinessInformation.md) | |
**KYC** | [**Boardingv1registrationsOrganizationInformationKYC**](Boardingv1registrationsOrganizationInformationKYC.md) | | [optional]
Expand Down
Loading

0 comments on commit 4902ffb

Please sign in to comment.