Skip to content

Commit 661b220

Browse files
Merge pull request #154 from CyberSource/release-march24
March Release 24
2 parents 5d313a3 + 82f513b commit 661b220

File tree

501 files changed

+51567
-811
lines changed

Some content is hidden

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

501 files changed

+51567
-811
lines changed

README.md

+1-1
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.48"
32+
"cybersource/rest-client-php": "0.0.49"
3333
}
3434
}
3535
```

composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cybersource/rest-client-php",
3-
"version": "0.0.48",
3+
"version": "0.0.49",
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/BillingAgreementsApi.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ All URIs are relative to *https://apitest.cybersource.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**billingAgreementsDeRegistration**](BillingAgreementsApi.md#billingAgreementsDeRegistration) | **PATCH** /pts/v2/billing-agreements/{id} | Standing Instruction Cancellation or Modification
7+
[**billingAgreementsDeRegistration**](BillingAgreementsApi.md#billingAgreementsDeRegistration) | **PATCH** /pts/v2/billing-agreements/{id} | Modify a Billing Agreement
88
[**billingAgreementsIntimation**](BillingAgreementsApi.md#billingAgreementsIntimation) | **POST** /pts/v2/billing-agreements/{id}/intimations | Standing Instruction intimation
9-
[**billingAgreementsRegistration**](BillingAgreementsApi.md#billingAgreementsRegistration) | **POST** /pts/v2/billing-agreements | Standing Instruction completion registration
9+
[**billingAgreementsRegistration**](BillingAgreementsApi.md#billingAgreementsRegistration) | **POST** /pts/v2/billing-agreements | Create a Billing Agreement
1010

1111

1212
# **billingAgreementsDeRegistration**
13-
> \CyberSource\Model\PtsV2CreditsPost201Response1 billingAgreementsDeRegistration($modifyBillingAgreement, $id)
13+
> \CyberSource\Model\PtsV2ModifyBillingAgreementPost201Response billingAgreementsDeRegistration($modifyBillingAgreement, $id)
1414
15-
Standing Instruction Cancellation or Modification
15+
Modify a Billing Agreement
1616

17-
Standing Instruction with or without Token
17+
#### 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.
1818

1919
### Example
2020
```php
@@ -43,7 +43,7 @@ Name | Type | Description | Notes
4343

4444
### Return type
4545

46-
[**\CyberSource\Model\PtsV2CreditsPost201Response1**](../Model/PtsV2CreditsPost201Response1.md)
46+
[**\CyberSource\Model\PtsV2ModifyBillingAgreementPost201Response**](../Model/PtsV2ModifyBillingAgreementPost201Response.md)
4747

4848
### Authorization
4949

@@ -104,11 +104,11 @@ No authorization required
104104
[[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)
105105

106106
# **billingAgreementsRegistration**
107-
> \CyberSource\Model\PtsV2CreditsPost201Response1 billingAgreementsRegistration($createBillingAgreement)
107+
> \CyberSource\Model\PtsV2CreateBillingAgreementPost201Response billingAgreementsRegistration($createBillingAgreement)
108108
109-
Standing Instruction completion registration
109+
Create a Billing Agreement
110110

111-
Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed
111+
#### Standing Instruction: Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed #### Create Mandate: You can create a mandate through the direct debit mandate flow. Possible create mandate status values: - Pending—the create mandate request was successfully processed. - Failed—the create mandate request was not accepted. #### Import Mandate: In the Bacs scheme, a mandate is created with a status of active. Direct debit collections can be made against it immediately. You can import a mandate to the CyberSource database when: - You have existing customers with signed, active mandates - You manage mandates outside of CyberSource. When you import an existing mandate to the CyberSource database, provide a unique value for the mandate ID or the request results in an error. If an import mandate request is not accepted, the import mandate status value is failed.
112112

113113
### Example
114114
```php
@@ -135,7 +135,7 @@ Name | Type | Description | Notes
135135

136136
### Return type
137137

138-
[**\CyberSource\Model\PtsV2CreditsPost201Response1**](../Model/PtsV2CreditsPost201Response1.md)
138+
[**\CyberSource\Model\PtsV2CreateBillingAgreementPost201Response**](../Model/PtsV2CreateBillingAgreementPost201Response.md)
139139

140140
### Authorization
141141

docs/Api/PaymentsApi.md

+142
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,61 @@ All URIs are relative to *https://apitest.cybersource.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**createOrderRequest**](PaymentsApi.md#createOrderRequest) | **POST** /pts/v2/payment-references/{id}/intents | Create a Payment Order Request
78
[**createPayment**](PaymentsApi.md#createPayment) | **POST** /pts/v2/payments | Process a Payment
9+
[**createSessionRequest**](PaymentsApi.md#createSessionRequest) | **POST** /pts/v2/payment-references | Create Alternative Payments Sessions Request
810
[**incrementAuth**](PaymentsApi.md#incrementAuth) | **PATCH** /pts/v2/payments/{id} | Increment an Authorization
911
[**refreshPaymentStatus**](PaymentsApi.md#refreshPaymentStatus) | **POST** /pts/v2/refresh-payment-status/{id} | Check a Payment Status
12+
[**updateSessionReq**](PaymentsApi.md#updateSessionReq) | **PATCH** /pts/v2/payment-references/{id} | Update Alternative Payments Sessions Request
1013

1114

15+
# **createOrderRequest**
16+
> \CyberSource\Model\PtsV2PaymentsOrderPost201Response createOrderRequest($orderPaymentRequest, $id)
17+
18+
Create a Payment Order Request
19+
20+
Create a Payment Order Request
21+
22+
### Example
23+
```php
24+
<?php
25+
require_once(__DIR__ . '/vendor/autoload.php');
26+
27+
$api_instance = new CyberSource\Api\PaymentsApi();
28+
$orderPaymentRequest = new \CyberSource\Model\OrderPaymentRequest(); // \CyberSource\Model\OrderPaymentRequest |
29+
$id = "id_example"; // string | Request identifier number for the order request.
30+
31+
try {
32+
$result = $api_instance->createOrderRequest($orderPaymentRequest, $id);
33+
print_r($result);
34+
} catch (Exception $e) {
35+
echo 'Exception when calling PaymentsApi->createOrderRequest: ', $e->getMessage(), PHP_EOL;
36+
}
37+
?>
38+
```
39+
40+
### Parameters
41+
42+
Name | Type | Description | Notes
43+
------------- | ------------- | ------------- | -------------
44+
**orderPaymentRequest** | [**\CyberSource\Model\OrderPaymentRequest**](../Model/OrderPaymentRequest.md)| |
45+
**id** | **string**| Request identifier number for the order request. |
46+
47+
### Return type
48+
49+
[**\CyberSource\Model\PtsV2PaymentsOrderPost201Response**](../Model/PtsV2PaymentsOrderPost201Response.md)
50+
51+
### Authorization
52+
53+
No authorization required
54+
55+
### HTTP request headers
56+
57+
- **Content-Type**: application/json;charset=utf-8
58+
- **Accept**: application/hal+json;charset=utf-8
59+
60+
[[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)
61+
1262
# **createPayment**
1363
> \CyberSource\Model\PtsV2PaymentsPost201Response createPayment($createPaymentRequest)
1464
@@ -54,6 +104,51 @@ No authorization required
54104

55105
[[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)
56106

107+
# **createSessionRequest**
108+
> \CyberSource\Model\PtsV2PaymentsPost201Response2 createSessionRequest($createSessionReq)
109+
110+
Create Alternative Payments Sessions Request
111+
112+
Create Alternative Payments Sessions Request
113+
114+
### Example
115+
```php
116+
<?php
117+
require_once(__DIR__ . '/vendor/autoload.php');
118+
119+
$api_instance = new CyberSource\Api\PaymentsApi();
120+
$createSessionReq = new \CyberSource\Model\CreateSessionReq(); // \CyberSource\Model\CreateSessionReq |
121+
122+
try {
123+
$result = $api_instance->createSessionRequest($createSessionReq);
124+
print_r($result);
125+
} catch (Exception $e) {
126+
echo 'Exception when calling PaymentsApi->createSessionRequest: ', $e->getMessage(), PHP_EOL;
127+
}
128+
?>
129+
```
130+
131+
### Parameters
132+
133+
Name | Type | Description | Notes
134+
------------- | ------------- | ------------- | -------------
135+
**createSessionReq** | [**\CyberSource\Model\CreateSessionReq**](../Model/CreateSessionReq.md)| |
136+
137+
### Return type
138+
139+
[**\CyberSource\Model\PtsV2PaymentsPost201Response2**](../Model/PtsV2PaymentsPost201Response2.md)
140+
141+
### Authorization
142+
143+
No authorization required
144+
145+
### HTTP request headers
146+
147+
- **Content-Type**: application/json;charset=utf-8
148+
- **Accept**: application/hal+json;charset=utf-8
149+
150+
[[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)
151+
57152
# **incrementAuth**
58153
> \CyberSource\Model\PtsV2IncrementalAuthorizationPatch201Response incrementAuth($id, $incrementAuthRequest)
59154
@@ -148,3 +243,50 @@ No authorization required
148243

149244
[[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)
150245

246+
# **updateSessionReq**
247+
> \CyberSource\Model\PtsV2PaymentsPost201Response2 updateSessionReq($createSessionRequest, $id)
248+
249+
Update Alternative Payments Sessions Request
250+
251+
Update Alternative Payments Sessions Request
252+
253+
### Example
254+
```php
255+
<?php
256+
require_once(__DIR__ . '/vendor/autoload.php');
257+
258+
$api_instance = new CyberSource\Api\PaymentsApi();
259+
$createSessionRequest = new \CyberSource\Model\CreateSessionRequest(); // \CyberSource\Model\CreateSessionRequest |
260+
$id = "id_example"; // string | The payment ID. This ID is returned from a previous payment request.
261+
262+
try {
263+
$result = $api_instance->updateSessionReq($createSessionRequest, $id);
264+
print_r($result);
265+
} catch (Exception $e) {
266+
echo 'Exception when calling PaymentsApi->updateSessionReq: ', $e->getMessage(), PHP_EOL;
267+
}
268+
?>
269+
```
270+
271+
### Parameters
272+
273+
Name | Type | Description | Notes
274+
------------- | ------------- | ------------- | -------------
275+
**createSessionRequest** | [**\CyberSource\Model\CreateSessionRequest**](../Model/CreateSessionRequest.md)| |
276+
**id** | **string**| The payment ID. This ID is returned from a previous payment request. |
277+
278+
### Return type
279+
280+
[**\CyberSource\Model\PtsV2PaymentsPost201Response2**](../Model/PtsV2PaymentsPost201Response2.md)
281+
282+
### Authorization
283+
284+
No authorization required
285+
286+
### HTTP request headers
287+
288+
- **Content-Type**: application/json;charset=utf-8
289+
- **Accept**: application/hal+json;charset=utf-8
290+
291+
[[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)
292+

docs/Api/TransientTokenDataApi.md

+46
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,55 @@ All URIs are relative to *https://apitest.cybersource.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**getPaymentCredentialsForTransientToken**](TransientTokenDataApi.md#getPaymentCredentialsForTransientToken) | **GET** /up/v1/payment-credentials/{jti} | Get Payment Credentials
78
[**getTransactionForTransientToken**](TransientTokenDataApi.md#getTransactionForTransientToken) | **GET** /up/v1/payment-details/{transientToken} | Get Transient Token Data
89

910

11+
# **getPaymentCredentialsForTransientToken**
12+
> string getPaymentCredentialsForTransientToken($jti)
13+
14+
Get Payment Credentials
15+
16+
Retrieve the Payment data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will return PCI payment data captured by the Unified Checkout platform.
17+
18+
### Example
19+
```php
20+
<?php
21+
require_once(__DIR__ . '/vendor/autoload.php');
22+
23+
$api_instance = new CyberSource\Api\TransientTokenDataApi();
24+
$jti = "jti_example"; // string | The jti field contained within the Transient token returned from a successful Unified Checkout transaction
25+
26+
try {
27+
$result = $api_instance->getPaymentCredentialsForTransientToken($jti);
28+
print_r($result);
29+
} catch (Exception $e) {
30+
echo 'Exception when calling TransientTokenDataApi->getPaymentCredentialsForTransientToken: ', $e->getMessage(), PHP_EOL;
31+
}
32+
?>
33+
```
34+
35+
### Parameters
36+
37+
Name | Type | Description | Notes
38+
------------- | ------------- | ------------- | -------------
39+
**jti** | **string**| The jti field contained within the Transient token returned from a successful Unified Checkout transaction |
40+
41+
### Return type
42+
43+
**string**
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
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
# **getTransactionForTransientToken**
1157
> getTransactionForTransientToken($transientToken)
1258

docs/Api/UnifiedCheckoutCaptureContextApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212
1313
Generate Unified Checkout Capture Context
1414

15-
Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout within a merchant web page
15+
Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). For more information about Click to Pay drop in UI, see the [Click to Pay Drop-in UI Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/click-to-pay/developer/all/rest/click-to-pay/ctp-intro.html). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page
1616

1717
### Example
1818
```php

docs/Model/AuthReversalRequest.md

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
88
**processingInformation** | [**\CyberSource\Model\Ptsv2paymentsidreversalsProcessingInformation**](Ptsv2paymentsidreversalsProcessingInformation.md) | | [optional]
99
**orderInformation** | [**\CyberSource\Model\Ptsv2paymentsidreversalsOrderInformation**](Ptsv2paymentsidreversalsOrderInformation.md) | | [optional]
1010
**pointOfSaleInformation** | [**\CyberSource\Model\Ptsv2paymentsidreversalsPointOfSaleInformation**](Ptsv2paymentsidreversalsPointOfSaleInformation.md) | | [optional]
11+
**paymentInformation** | [**\CyberSource\Model\Ptsv2paymentsidreversalsPaymentInformation**](Ptsv2paymentsidreversalsPaymentInformation.md) | | [optional]
12+
**processorInformation** | [**\CyberSource\Model\Ptsv2paymentsProcessorInformationReversal**](Ptsv2paymentsProcessorInformationReversal.md) | | [optional]
1113

1214
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1315

docs/Model/CardProcessingConfigCommon.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**processors** | [**map[string,\CyberSource\Model\CardProcessingConfigCommonProcessors]**](CardProcessingConfigCommonProcessors.md) | e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &amp;lt;your vpc processor&amp;gt; | [optional]
6+
**processors** | [**map[string,\CyberSource\Model\CardProcessingConfigCommonProcessors]**](CardProcessingConfigCommonProcessors.md) | e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpngsapv3 * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &amp;lt;your vpc processor&amp;gt; | [optional]
77
**amexVendorCode** | **string** | Vendor code assigned by American Express. Applicable for TSYS (tsys) processor. | [optional]
88
**defaultAuthTypeCode** | **string** | Authorization Finality indicator. Please note that the input can be in small case or capitals but response is in small case as of now. It will be made capitals everywhere in the next version. Applicable for Elavon Americas (elavonamericas), TSYS (tsys), Barclays (barclays2), Streamline (streamline2), Six (six), Barclays HISO (barclayshiso), GPN (gpn), FDI Global (fdiglobal), GPX (gpx), Paymentech Tampa (paymentechtampa), FDC Nashville (smartfdc), VPC and Chase Paymentech Salem (chasepaymentechsalem) processors. Validation details (for selected processors)... &lt;table&gt; &lt;thead&gt;&lt;tr&gt;&lt;th&gt;Processor&lt;/th&gt;&lt;th&gt;Acceptance Type&lt;/th&gt;&lt;th&gt;Required&lt;/th&gt;&lt;th&gt;Default Value&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt; &lt;tr&gt;&lt;td&gt;Barclays&lt;/td&gt;&lt;td&gt;cnp, cp, hybrid&lt;/td&gt;&lt;td&gt;No&lt;/td&gt;&lt;td&gt;FINAL&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Barclays HISO&lt;/td&gt;&lt;td&gt;cnp, cp, hybrid&lt;/td&gt;&lt;td&gt;Yes&lt;/td&gt;&lt;td&gt;FINAL&lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; | [optional]
99
**masterCardAssignedId** | **string** | MAID aka MasterCard assigned ID, MasterCard equivalent of Merchant Verification Value by Visa. Applicable for VPC, GPX (gpx) and FDI Global (fdiglobal) processors. | [optional]

0 commit comments

Comments
 (0)