Skip to content

Commit ea5ea08

Browse files
authored
Merge pull request #140 from CyberSource/oct-release
Oct release
2 parents dfff935 + eb10598 commit ea5ea08

File tree

738 files changed

+114963
-1251
lines changed

Some content is hidden

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

738 files changed

+114963
-1251
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,3 +211,6 @@ For Mac/Linux/Unix:
211211
Download the php_apcu using pecl command: "pecl install apcu". It will auto download the applicable apcu extension for the PHP v8.0, v8.1, v8.2.
212212

213213

214+
### Disclaimer
215+
216+
Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested (“Beta Product”) solely for the purpose of evaluating the functionality or marketability of the Beta Product (a “Beta Evaluation”). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer’s participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period (“Beta Product Form”). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer’s use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided “AS IS” and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.

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\InlineResponse2004 getBatchReport($batchId)
14+
> \CyberSource\Model\InlineResponse2007 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\InlineResponse2004**](../Model/InlineResponse2004.md)
45+
[**\CyberSource\Model\InlineResponse2007**](../Model/InlineResponse2007.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\InlineResponse2003 getBatchStatus($batchId)
59+
> \CyberSource\Model\InlineResponse2006 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\InlineResponse2003**](../Model/InlineResponse2003.md)
90+
[**\CyberSource\Model\InlineResponse2006**](../Model/InlineResponse2006.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\InlineResponse2002 getBatchesList($offset, $limit, $fromDate, $toDate)
104+
> \CyberSource\Model\InlineResponse2005 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\InlineResponse2002**](../Model/InlineResponse2002.md)
141+
[**\CyberSource\Model\InlineResponse2005**](../Model/InlineResponse2005.md)
142142

143143
### Authorization
144144

docs/Api/CreateNewWebhooksApi.md

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
# CyberSource\CreateNewWebhooksApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**createWebhook**](CreateNewWebhooksApi.md#createWebhook) | **POST** /notification-subscriptions/v1/webhooks | Create a Webhook
8+
[**findProductToSubscribe**](CreateNewWebhooksApi.md#findProductToSubscribe) | **GET** /notification-subscriptions/v1/products/{organizationId} | Find Products You Can Subscribe To
9+
[**saveSymEgressKey**](CreateNewWebhooksApi.md#saveSymEgressKey) | **POST** /kms/egress/v2/keys-sym | Create Webhook Security Keys
10+
11+
12+
# **createWebhook**
13+
> \CyberSource\Model\InlineResponse2013 createWebhook($createWebhook)
14+
15+
Create a Webhook
16+
17+
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.
18+
19+
### Example
20+
```php
21+
<?php
22+
require_once(__DIR__ . '/vendor/autoload.php');
23+
24+
$api_instance = new CyberSource\Api\CreateNewWebhooksApi();
25+
$createWebhook = new \CyberSource\Model\CreateWebhook(); // \CyberSource\Model\CreateWebhook | The webhook payload
26+
27+
try {
28+
$result = $api_instance->createWebhook($createWebhook);
29+
print_r($result);
30+
} catch (Exception $e) {
31+
echo 'Exception when calling CreateNewWebhooksApi->createWebhook: ', $e->getMessage(), PHP_EOL;
32+
}
33+
?>
34+
```
35+
36+
### Parameters
37+
38+
Name | Type | Description | Notes
39+
------------- | ------------- | ------------- | -------------
40+
**createWebhook** | [**\CyberSource\Model\CreateWebhook**](../Model/CreateWebhook.md)| The webhook payload | [optional]
41+
42+
### Return type
43+
44+
[**\CyberSource\Model\InlineResponse2013**](../Model/InlineResponse2013.md)
45+
46+
### Authorization
47+
48+
No authorization required
49+
50+
### HTTP request headers
51+
52+
- **Content-Type**: application/json;charset=utf-8
53+
- **Accept**: application/hal+json;charset=utf-8
54+
55+
[[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)
56+
57+
# **findProductToSubscribe**
58+
> \CyberSource\Model\InlineResponse2003[] findProductToSubscribe($organizationId)
59+
60+
Find Products You Can Subscribe To
61+
62+
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.
63+
64+
### Example
65+
```php
66+
<?php
67+
require_once(__DIR__ . '/vendor/autoload.php');
68+
69+
$api_instance = new CyberSource\Api\CreateNewWebhooksApi();
70+
$organizationId = "organizationId_example"; // string | The Organization Identifier.
71+
72+
try {
73+
$result = $api_instance->findProductToSubscribe($organizationId);
74+
print_r($result);
75+
} catch (Exception $e) {
76+
echo 'Exception when calling CreateNewWebhooksApi->findProductToSubscribe: ', $e->getMessage(), PHP_EOL;
77+
}
78+
?>
79+
```
80+
81+
### Parameters
82+
83+
Name | Type | Description | Notes
84+
------------- | ------------- | ------------- | -------------
85+
**organizationId** | **string**| The Organization Identifier. |
86+
87+
### Return type
88+
89+
[**\CyberSource\Model\InlineResponse2003[]**](../Model/InlineResponse2003.md)
90+
91+
### Authorization
92+
93+
No authorization required
94+
95+
### HTTP request headers
96+
97+
- **Content-Type**: application/json;charset=utf-8
98+
- **Accept**: application/hal+json;charset=utf-8
99+
100+
[[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)
101+
102+
# **saveSymEgressKey**
103+
> \CyberSource\Model\InlineResponse2012 saveSymEgressKey($vCSenderOrganizationId, $vCPermissions, $vCCorrelationId, $saveSymEgressKey)
104+
105+
Create Webhook Security Keys
106+
107+
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.
108+
109+
### Example
110+
```php
111+
<?php
112+
require_once(__DIR__ . '/vendor/autoload.php');
113+
114+
$api_instance = new CyberSource\Api\CreateNewWebhooksApi();
115+
$vCSenderOrganizationId = "vCSenderOrganizationId_example"; // string | Sender organization id
116+
$vCPermissions = "vCPermissions_example"; // string | Encoded user permissions returned by the CGK, for the entity user who initiated the boarding
117+
$vCCorrelationId = "vCCorrelationId_example"; // string | A globally unique id associated with your request
118+
$saveSymEgressKey = new \CyberSource\Model\SaveSymEgressKey(); // \CyberSource\Model\SaveSymEgressKey | Provide egress Symmetric key information to save (create or store or refresh)
119+
120+
try {
121+
$result = $api_instance->saveSymEgressKey($vCSenderOrganizationId, $vCPermissions, $vCCorrelationId, $saveSymEgressKey);
122+
print_r($result);
123+
} catch (Exception $e) {
124+
echo 'Exception when calling CreateNewWebhooksApi->saveSymEgressKey: ', $e->getMessage(), PHP_EOL;
125+
}
126+
?>
127+
```
128+
129+
### Parameters
130+
131+
Name | Type | Description | Notes
132+
------------- | ------------- | ------------- | -------------
133+
**vCSenderOrganizationId** | **string**| Sender organization id |
134+
**vCPermissions** | **string**| Encoded user permissions returned by the CGK, for the entity user who initiated the boarding |
135+
**vCCorrelationId** | **string**| A globally unique id associated with your request | [optional]
136+
**saveSymEgressKey** | [**\CyberSource\Model\SaveSymEgressKey**](../Model/SaveSymEgressKey.md)| Provide egress Symmetric key information to save (create or store or refresh) | [optional]
137+
138+
### Return type
139+
140+
[**\CyberSource\Model\InlineResponse2012**](../Model/InlineResponse2012.md)
141+
142+
### Authorization
143+
144+
No authorization required
145+
146+
### HTTP request headers
147+
148+
- **Content-Type**: application/json;charset=utf-8
149+
- **Accept**: application/hal+json;charset=utf-8
150+
151+
[[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)
152+

docs/Api/InvoiceSettingsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Method | HTTP request | Description
1313
1414
Get Invoice Settings
1515

16-
Get the invoice settings for the invoice payment page.
16+
Allows you to retrieve the invoice settings for the payment page.
1717

1818
### Example
1919
```php
@@ -54,7 +54,7 @@ No authorization required
5454
5555
Update Invoice Settings
5656

57-
Update invoice settings for the invoice payment page.
57+
Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.
5858

5959
### Example
6060
```php

docs/Api/InvoicesApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Method | HTTP request | Description
1717
1818
Create a New Invoice
1919

20-
Create a new invoice.
20+
The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device. You can either use the system generated email or use the invoice payment link in your own communication. You can add discounts and taxes for the entire invoice or for each line item. To customize the invoice to match your brand see [Invoice Settings](https://developer.cybersource.com/api-reference-assets/index.html#invoicing_invoice-settings_update-invoice-settings). The invoice payment page uses Unified Checkout to process the payments.
2121

2222
### Example
2323
```php
@@ -62,7 +62,7 @@ No authorization required
6262
6363
Get a List of Invoices
6464

65-
Get a list of invoices.
65+
Provides a (filtered) list of invoices that have been created in your account. You can filter the list based on Invoice Status by setting the status query parameter to one of DRAFT, CREATED, SENT, PARTIAL, PAID or CANCELED.
6666

6767
### Example
6868
```php
@@ -111,7 +111,7 @@ No authorization required
111111
112112
Get Invoice Details
113113

114-
Get the details of a specific invoice.
114+
You can retrieve details of a specific invoice. This can be used to check the Invoice status and get a list of invoice payments in the invoice history section of the response. For each payment transaction you can use the Transaction Details API to get more details on the payment transaction.
115115

116116
### Example
117117
```php
@@ -156,7 +156,7 @@ No authorization required
156156
157157
Cancel an Invoice
158158

159-
Cancel an invoice.
159+
You can cancel an invoice if no payment is made to it. You cannot cancel partially or fully paid invoices.
160160

161161
### Example
162162
```php
@@ -201,7 +201,7 @@ No authorization required
201201
202202
Send an Invoice
203203

204-
Send an invoice.
204+
You can send an invoice in draft or created state or resend a sent or partially paid invoice. Fully paid or canceled invoices cannot be resent.
205205

206206
### Example
207207
```php
@@ -246,7 +246,7 @@ No authorization required
246246
247247
Update an Invoice
248248

249-
Update an invoice.
249+
You can update all information except the invoice number till any payment is received for an invoice. Invoices that are partially or fully paid or cancelled cannot be updated.
250250

251251
### Example
252252
```php

0 commit comments

Comments
 (0)