Skip to content

Commit 7fb4752

Browse files
gaubansagaubansa
authored
Merge pull request #188 from CyberSource/june-2025
Monthly API changes June 2025
2 parents 8ee821f + 2e61cbc commit 7fb4752

File tree

141 files changed

+8500
-1414
lines changed

Some content is hidden

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

141 files changed

+8500
-1414
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ override the new secure-http default setting)*.
2929
{
3030
"require": {
3131
"php": ">=8.0.0",
32-
"cybersource/rest-client-php": "0.0.62"
32+
"cybersource/rest-client-php": "0.0.63"
3333
}
3434
}
3535
```

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cybersource/rest-client-php",
3-
"version": "0.0.62",
3+
"version": "0.0.63",
44
"description": "Client SDK for CyberSource REST APIs",
55
"keywords": [
66
"cybersource", "payments", "ecommerce", "merchant", "merchants", "authorize", "visa", "payment", "payment-gateway", "payment-integration", "payment-module", "payment-processing", "payment-service", "payment-methods"

‎docs/Api/BatchesApi.md‎

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

1212

1313
# **getBatchReport**
14-
> \CyberSource\Model\InlineResponse2009 getBatchReport($batchId)
14+
> \CyberSource\Model\InlineResponse20010 getBatchReport($batchId)
1515
1616
Retrieve a Batch Report
1717

@@ -42,7 +42,7 @@ Name | Type | Description | Notes
4242

4343
### Return type
4444

45-
[**\CyberSource\Model\InlineResponse2009**](../Model/InlineResponse2009.md)
45+
[**\CyberSource\Model\InlineResponse20010**](../Model/InlineResponse20010.md)
4646

4747
### Authorization
4848

@@ -56,7 +56,7 @@ No authorization required
5656
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
5757

5858
# **getBatchStatus**
59-
> \CyberSource\Model\InlineResponse2008 getBatchStatus($batchId)
59+
> \CyberSource\Model\InlineResponse2009 getBatchStatus($batchId)
6060
6161
Retrieve a Batch Status
6262

@@ -87,7 +87,7 @@ Name | Type | Description | Notes
8787

8888
### Return type
8989

90-
[**\CyberSource\Model\InlineResponse2008**](../Model/InlineResponse2008.md)
90+
[**\CyberSource\Model\InlineResponse2009**](../Model/InlineResponse2009.md)
9191

9292
### Authorization
9393

@@ -101,7 +101,7 @@ No authorization required
101101
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
102102

103103
# **getBatchesList**
104-
> \CyberSource\Model\InlineResponse2007 getBatchesList($offset, $limit, $fromDate, $toDate)
104+
> \CyberSource\Model\InlineResponse2008 getBatchesList($offset, $limit, $fromDate, $toDate)
105105
106106
List Batches
107107

@@ -138,7 +138,7 @@ Name | Type | Description | Notes
138138

139139
### Return type
140140

141-
[**\CyberSource\Model\InlineResponse2007**](../Model/InlineResponse2007.md)
141+
[**\CyberSource\Model\InlineResponse2008**](../Model/InlineResponse2008.md)
142142

143143
### Authorization
144144

‎docs/Api/DeviceDeAssociationApi.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
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+
# **deleteTerminalAssociation**
12+
> deleteTerminalAssociation($deAssociationRequestBody)
13+
14+
De-associate a device from merchant or account V2
15+
16+
The current association of the device will be removed and will be assigned back to parent in the hierarchy based on internal logic
17+
18+
### Example
19+
```php
20+
<?php
21+
require_once(__DIR__ . '/vendor/autoload.php');
22+
23+
$api_instance = new CyberSource\Api\DeviceDeAssociationApi();
24+
$deAssociationRequestBody = new \CyberSource\Model\DeAssociationRequestBody(); // \CyberSource\Model\DeAssociationRequestBody | de association of the deviceId in the request body.
25+
26+
try {
27+
$api_instance->deleteTerminalAssociation($deAssociationRequestBody);
28+
} catch (Exception $e) {
29+
echo 'Exception when calling DeviceDeAssociationApi->deleteTerminalAssociation: ', $e->getMessage(), PHP_EOL;
30+
}
31+
?>
32+
```
33+
34+
### Parameters
35+
36+
Name | Type | Description | Notes
37+
------------- | ------------- | ------------- | -------------
38+
**deAssociationRequestBody** | [**\CyberSource\Model\DeAssociationRequestBody**](../Model/DeAssociationRequestBody.md)| de association of the deviceId in the request body. |
39+
40+
### Return type
41+
42+
void (empty response body)
43+
44+
### Authorization
45+
46+
No authorization required
47+
48+
### HTTP request headers
49+
50+
- **Content-Type**: application/json;charset=UTF-8
51+
- **Accept**: application/hal+json;charset=utf-8
52+
53+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
54+
55+
# **postDeAssociateV3Terminal**
56+
> \CyberSource\Model\InlineResponse2006[] postDeAssociateV3Terminal($deviceDeAssociateV3Request)
57+
58+
De-associate a device from merchant to account or reseller and from account to reseller
59+
60+
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.
61+
62+
### Example
63+
```php
64+
<?php
65+
require_once(__DIR__ . '/vendor/autoload.php');
66+
67+
$api_instance = new CyberSource\Api\DeviceDeAssociationApi();
68+
$deviceDeAssociateV3Request = array(new \CyberSource\Model\DeviceDeAssociateV3Request()); // \CyberSource\Model\DeviceDeAssociateV3Request[] | deviceId that has to be de-associated to the destination organizationId.
69+
70+
try {
71+
$result = $api_instance->postDeAssociateV3Terminal($deviceDeAssociateV3Request);
72+
print_r($result);
73+
} catch (Exception $e) {
74+
echo 'Exception when calling DeviceDeAssociationApi->postDeAssociateV3Terminal: ', $e->getMessage(), PHP_EOL;
75+
}
76+
?>
77+
```
78+
79+
### Parameters
80+
81+
Name | Type | Description | Notes
82+
------------- | ------------- | ------------- | -------------
83+
**deviceDeAssociateV3Request** | [**\CyberSource\Model\DeviceDeAssociateV3Request[]**](../Model/DeviceDeAssociateV3Request.md)| deviceId that has to be de-associated to the destination organizationId. |
84+
85+
### Return type
86+
87+
[**\CyberSource\Model\InlineResponse2006[]**](../Model/InlineResponse2006.md)
88+
89+
### Authorization
90+
91+
No authorization required
92+
93+
### HTTP request headers
94+
95+
- **Content-Type**: application/json;charset=UTF-8
96+
- **Accept**: application/json;charset=UTF-8
97+
98+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
99+

‎docs/Api/DeviceDeAssociationV3Api.md‎

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

‎docs/Api/DeviceSearchApi.md‎

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,59 @@ 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+
# **postSearchQuery**
12+
> \CyberSource\Model\InlineResponse2005 postSearchQuery($postDeviceSearchRequest)
13+
14+
Retrieve List of Devices for a given search query V2
15+
16+
Retrieves list of terminals in paginated format.
17+
18+
### Example
19+
```php
20+
<?php
21+
require_once(__DIR__ . '/vendor/autoload.php');
22+
23+
$api_instance = new CyberSource\Api\DeviceSearchApi();
24+
$postDeviceSearchRequest = new \CyberSource\Model\PostDeviceSearchRequest(); // \CyberSource\Model\PostDeviceSearchRequest |
25+
26+
try {
27+
$result = $api_instance->postSearchQuery($postDeviceSearchRequest);
28+
print_r($result);
29+
} catch (Exception $e) {
30+
echo 'Exception when calling DeviceSearchApi->postSearchQuery: ', $e->getMessage(), PHP_EOL;
31+
}
32+
?>
33+
```
34+
35+
### Parameters
36+
37+
Name | Type | Description | Notes
38+
------------- | ------------- | ------------- | -------------
39+
**postDeviceSearchRequest** | [**\CyberSource\Model\PostDeviceSearchRequest**](../Model/PostDeviceSearchRequest.md)| |
40+
41+
### Return type
42+
43+
[**\CyberSource\Model\InlineResponse2005**](../Model/InlineResponse2005.md)
44+
45+
### Authorization
46+
47+
No authorization required
48+
49+
### HTTP request headers
50+
51+
- **Content-Type**: application/json;charset=UTF-8
52+
- **Accept**: application/json;charset=UTF-8
53+
54+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
55+
1056
# **postSearchQueryV3**
11-
> \CyberSource\Model\InlineResponse2006 postSearchQueryV3($postDeviceSearchRequestV3)
57+
> \CyberSource\Model\InlineResponse2007 postSearchQueryV3($postDeviceSearchRequestV3)
1258
13-
Retrieve List of Devices for a given search query V3
59+
Retrieve List of Devices for a given search query
1460

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

@@ -39,7 +85,7 @@ Name | Type | Description | Notes
3985

4086
### Return type
4187

42-
[**\CyberSource\Model\InlineResponse2006**](../Model/InlineResponse2006.md)
88+
[**\CyberSource\Model\InlineResponse2007**](../Model/InlineResponse2007.md)
4389

4490
### Authorization
4591

‎docs/Api/SubscriptionsApi.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Method | HTTP request | Description
1515

1616

1717
# **activateSubscription**
18-
> \CyberSource\Model\ActivateSubscriptionResponse activateSubscription($id)
18+
> \CyberSource\Model\ActivateSubscriptionResponse activateSubscription($id, $processSkippedPayments)
1919
2020
Activate a Subscription
2121

22-
Activate a `CANCELLED` Or `SUSPENDED` Subscription
22+
Activate a `SUSPENDED` Subscription
2323

2424
### Example
2525
```php
@@ -28,9 +28,10 @@ require_once(__DIR__ . '/vendor/autoload.php');
2828

2929
$api_instance = new CyberSource\Api\SubscriptionsApi();
3030
$id = "id_example"; // string | Subscription Id
31+
$processSkippedPayments = true; // bool | Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true.
3132

3233
try {
33-
$result = $api_instance->activateSubscription($id);
34+
$result = $api_instance->activateSubscription($id, $processSkippedPayments);
3435
print_r($result);
3536
} catch (Exception $e) {
3637
echo 'Exception when calling SubscriptionsApi->activateSubscription: ', $e->getMessage(), PHP_EOL;
@@ -43,6 +44,7 @@ try {
4344
Name | Type | Description | Notes
4445
------------- | ------------- | ------------- | -------------
4546
**id** | **string**| Subscription Id |
47+
**processSkippedPayments** | **bool**| Indicates if skipped payments should be processed from the period when the subscription was suspended. By default, this is set to true. | [optional] [default to true]
4648

4749
### Return type
4850

‎docs/Model/DeAssociationRequestBody.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# 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+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/Model/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&lt;br&gt;&lt;br&gt; If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ \&quot;https://example.com\&quot;, \&quot;https://basket.example.com\&quot;, \&quot;https://ecom.example.com\&quot; ]&lt;br&gt;&lt;br&gt; 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 &lt;br&gt;&lt;br&gt; | [optional]
1010
**transientTokenResponseOptions** | [**\CyberSource\Model\Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) | | [optional]
1111

0 commit comments

Comments
 (0)