Skip to content

Commit e78f816

Browse files
gnongsiegnongsie
authored
Merge pull request #166 from CyberSource/june-2025
Monthly API changes June 2025
2 parents 5282142 + 4ce3166 commit e78f816

File tree

142 files changed

+4690
-1187
lines changed

Some content is hidden

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

142 files changed

+4690
-1187
lines changed

‎docs/BatchesApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212

1313
<a name="getBatchReport"></a>
1414
# **getBatchReport**
15-
> InlineResponse2009 getBatchReport(batchId)
15+
> InlineResponse20010 getBatchReport(batchId)
1616
1717
Retrieve a Batch Report
1818

@@ -45,7 +45,7 @@ Name | Type | Description | Notes
4545

4646
### Return type
4747

48-
[**InlineResponse2009**](InlineResponse2009.md)
48+
[**InlineResponse20010**](InlineResponse20010.md)
4949

5050
### Authorization
5151

@@ -58,7 +58,7 @@ No authorization required
5858

5959
<a name="getBatchStatus"></a>
6060
# **getBatchStatus**
61-
> InlineResponse2008 getBatchStatus(batchId)
61+
> InlineResponse2009 getBatchStatus(batchId)
6262
6363
Retrieve a Batch Status
6464

@@ -91,7 +91,7 @@ Name | Type | Description | Notes
9191

9292
### Return type
9393

94-
[**InlineResponse2008**](InlineResponse2008.md)
94+
[**InlineResponse2009**](InlineResponse2009.md)
9595

9696
### Authorization
9797

@@ -104,7 +104,7 @@ No authorization required
104104

105105
<a name="getBatchesList"></a>
106106
# **getBatchesList**
107-
> InlineResponse2007 getBatchesList(opts)
107+
> InlineResponse2008 getBatchesList(opts)
108108
109109
List Batches
110110

@@ -144,7 +144,7 @@ Name | Type | Description | Notes
144144

145145
### Return type
146146

147-
[**InlineResponse2007**](InlineResponse2007.md)
147+
[**InlineResponse2008**](InlineResponse2008.md)
148148

149149
### Authorization
150150

‎docs/DeAssociationRequestBody.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource.DeAssociationRequestBody
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**deviceId** | **String** | UUID of the device which needs to be de-associated | [optional]
7+
8+

‎docs/DeviceDeAssociationApi.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# CyberSource.DeviceDeAssociationApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**deleteTerminalAssociation**](DeviceDeAssociationApi.md#deleteTerminalAssociation) | **PATCH** /dms/v2/devices/deassociate | De-associate a device from merchant or account V2
8+
[**postDeAssociateV3Terminal**](DeviceDeAssociationApi.md#postDeAssociateV3Terminal) | **POST** /dms/v3/devices/deassociate | De-associate a device from merchant to account or reseller and from account to reseller
9+
10+
11+
<a name="deleteTerminalAssociation"></a>
12+
# **deleteTerminalAssociation**
13+
> deleteTerminalAssociation(deAssociationRequestBody)
14+
15+
De-associate a device from merchant or account V2
16+
17+
The current association of the device will be removed and will be assigned back to parent in the hierarchy based on internal logic
18+
19+
### Example
20+
```javascript
21+
var CyberSource = require('CyberSource');
22+
23+
var apiInstance = new CyberSource.DeviceDeAssociationApi();
24+
25+
var deAssociationRequestBody = new CyberSource.DeAssociationRequestBody(); // DeAssociationRequestBody | de association of the deviceId in the request body.
26+
27+
28+
var callback = function(error, data, response) {
29+
if (error) {
30+
console.error(error);
31+
} else {
32+
console.log('API called successfully.');
33+
}
34+
};
35+
apiInstance.deleteTerminalAssociation(deAssociationRequestBody, callback);
36+
```
37+
38+
### Parameters
39+
40+
Name | Type | Description | Notes
41+
------------- | ------------- | ------------- | -------------
42+
**deAssociationRequestBody** | [**DeAssociationRequestBody**](DeAssociationRequestBody.md)| de association of the deviceId in the request body. |
43+
44+
### Return type
45+
46+
null (empty response body)
47+
48+
### Authorization
49+
50+
No authorization required
51+
52+
### HTTP request headers
53+
54+
- **Content-Type**: application/json;charset=UTF-8
55+
- **Accept**: application/hal+json;charset=utf-8
56+
57+
<a name="postDeAssociateV3Terminal"></a>
58+
# **postDeAssociateV3Terminal**
59+
> [InlineResponse2006] postDeAssociateV3Terminal(deviceDeAssociateV3Request)
60+
61+
De-associate a device from merchant to account or reseller and from account to reseller
62+
63+
A device will be de-associated from its current organization and moved up in the hierarchy. The device's new position will be determined by a specified destination, either an account or a portfolio. If no destination is provided, the device will default to the currently logged-in user.
64+
65+
### Example
66+
```javascript
67+
var CyberSource = require('CyberSource');
68+
69+
var apiInstance = new CyberSource.DeviceDeAssociationApi();
70+
71+
var deviceDeAssociateV3Request = [new CyberSource.DeviceDeAssociateV3Request()]; // [DeviceDeAssociateV3Request] | deviceId that has to be de-associated to the destination organizationId.
72+
73+
74+
var callback = function(error, data, response) {
75+
if (error) {
76+
console.error(error);
77+
} else {
78+
console.log('API called successfully. Returned data: ' + data);
79+
}
80+
};
81+
apiInstance.postDeAssociateV3Terminal(deviceDeAssociateV3Request, callback);
82+
```
83+
84+
### Parameters
85+
86+
Name | Type | Description | Notes
87+
------------- | ------------- | ------------- | -------------
88+
**deviceDeAssociateV3Request** | [**[DeviceDeAssociateV3Request]**](DeviceDeAssociateV3Request.md)| deviceId that has to be de-associated to the destination organizationId. |
89+
90+
### Return type
91+
92+
[**[InlineResponse2006]**](InlineResponse2006.md)
93+
94+
### Authorization
95+
96+
No authorization required
97+
98+
### HTTP request headers
99+
100+
- **Content-Type**: application/json;charset=UTF-8
101+
- **Accept**: application/json;charset=UTF-8
102+

‎docs/DeviceDeAssociationV3Api.md

Lines changed: 0 additions & 55 deletions
This file was deleted.

‎docs/DeviceSearchApi.md

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,61 @@ All URIs are relative to *https://apitest.cybersource.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**postSearchQueryV3**](DeviceSearchApi.md#postSearchQueryV3) | **POST** /dms/v3/devices/search | Retrieve List of Devices for a given search query V3
7+
[**postSearchQuery**](DeviceSearchApi.md#postSearchQuery) | **POST** /dms/v2/devices/search | Retrieve List of Devices for a given search query V2
8+
[**postSearchQueryV3**](DeviceSearchApi.md#postSearchQueryV3) | **POST** /dms/v3/devices/search | Retrieve List of Devices for a given search query
89

910

11+
<a name="postSearchQuery"></a>
12+
# **postSearchQuery**
13+
> InlineResponse2005 postSearchQuery(postDeviceSearchRequest)
14+
15+
Retrieve List of Devices for a given search query V2
16+
17+
Retrieves list of terminals in paginated format.
18+
19+
### Example
20+
```javascript
21+
var CyberSource = require('CyberSource');
22+
23+
var apiInstance = new CyberSource.DeviceSearchApi();
24+
25+
var postDeviceSearchRequest = new CyberSource.PostDeviceSearchRequest(); // PostDeviceSearchRequest |
26+
27+
28+
var callback = function(error, data, response) {
29+
if (error) {
30+
console.error(error);
31+
} else {
32+
console.log('API called successfully. Returned data: ' + data);
33+
}
34+
};
35+
apiInstance.postSearchQuery(postDeviceSearchRequest, callback);
36+
```
37+
38+
### Parameters
39+
40+
Name | Type | Description | Notes
41+
------------- | ------------- | ------------- | -------------
42+
**postDeviceSearchRequest** | [**PostDeviceSearchRequest**](PostDeviceSearchRequest.md)| |
43+
44+
### Return type
45+
46+
[**InlineResponse2005**](InlineResponse2005.md)
47+
48+
### Authorization
49+
50+
No authorization required
51+
52+
### HTTP request headers
53+
54+
- **Content-Type**: application/json;charset=UTF-8
55+
- **Accept**: application/json;charset=UTF-8
56+
1057
<a name="postSearchQueryV3"></a>
1158
# **postSearchQueryV3**
12-
> InlineResponse2006 postSearchQueryV3(postDeviceSearchRequestV3)
59+
> InlineResponse2007 postSearchQueryV3(postDeviceSearchRequestV3)
1360
14-
Retrieve List of Devices for a given search query V3
61+
Retrieve List of Devices for a given search query
1562

1663
Search for devices matching a given search query. The search query supports serialNumber, readerId, terminalId, status, statusChangeReason or organizationId Matching results are paginated.
1764

@@ -42,7 +89,7 @@ Name | Type | Description | Notes
4289

4390
### Return type
4491

45-
[**InlineResponse2006**](InlineResponse2006.md)
92+
[**InlineResponse2007**](InlineResponse2007.md)
4693

4794
### Authorization
4895

‎docs/GenerateCaptureContextRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**clientVersion** | **String** | Specify the version of Microform that you want to use. | [optional]
77
**targetOrigins** | **[String]** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Microform 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\" ]<br><br> You can supply up to nine origins within the targetOrigins field for nested iframes. If the list of origins exceeds five ensure that you: - Compare the list of origins in the v2/sessions targetOrigins field against the location.ancestorOrigins of the browser. - Ensure that the count of origins and their content matches in both. If any origins are absent or mismatched, the system will prevent Microform from loading and display a client-side error message. | [optional]
8-
**allowedCardNetworks** | **[String]** | The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional]
8+
**allowedCardNetworks** | **[String]** | The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA - PAYPAK **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional]
99
**allowedPaymentTypes** | **[String]** | The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK <br><br> | [optional]
1010
**transientTokenResponseOptions** | [**Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) | | [optional]
1111

‎docs/GenerateUnifiedCheckoutCaptureContextRequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**clientVersion** | **String** | Specify the version of Unified Checkout that you want to use. | [optional]
77
**targetOrigins** | **[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]
8-
**allowedCardNetworks** | **[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]
9-
**allowedPaymentTypes** | **[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]
8+
**allowedCardNetworks** | **[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 - PAYPAK | [optional]
9+
**allowedPaymentTypes** | **[String]** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Unified Checkout also supports the following Alternative Payments: - AFTERPAY<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.<br><br> **Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa<br><br> If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. | [optional]
1010
**country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional]
1111
**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]
1212
**captureMandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional]

‎docs/GetSubscriptionResponse.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
1010
**subscriptionInformation** | [**GetAllSubscriptionsResponseSubscriptionInformation**](GetAllSubscriptionsResponseSubscriptionInformation.md) | | [optional]
1111
**paymentInformation** | [**GetAllSubscriptionsResponsePaymentInformation**](GetAllSubscriptionsResponsePaymentInformation.md) | | [optional]
1212
**orderInformation** | [**GetAllSubscriptionsResponseOrderInformation**](GetAllSubscriptionsResponseOrderInformation.md) | | [optional]
13+
**reactivationInformation** | [**GetSubscriptionResponseReactivationInformation**](GetSubscriptionResponseReactivationInformation.md) | | [optional]
1314

1415

‎docs/GetSubscriptionResponseReactivationInformation.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CyberSource.GetSubscriptionResponseReactivationInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**skippedPaymentsCount** | **String** | Number of payments that should have occurred while the subscription was in a suspended status. | [optional]
7+
**skippedPaymentsTotalAmount** | **String** | Total amount that will be charged upon reactivation if `processSkippedPayments` is set to `true`. | [optional]
8+
9+

0 commit comments

Comments
 (0)