Skip to content

Commit aa87285

Browse files
Merge pull request #170 from CyberSource/release-oct24
Release oct24
2 parents a9ddad7 + 6fef509 commit aa87285

File tree

332 files changed

+19284
-5075
lines changed

Some content is hidden

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

332 files changed

+19284
-5075
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.55"
32+
"cybersource/rest-client-php": "0.0.56"
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.55",
3+
"version": "0.0.56",
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/OrdersApi.md

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# CyberSource\OrdersApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**createOrder**](OrdersApi.md#createOrder) | **POST** /pts/v2/intents | Create an Order
8+
[**updateOrder**](OrdersApi.md#updateOrder) | **PATCH** /pts/v2/intents/{id} | Update an Order
9+
10+
11+
# **createOrder**
12+
> \CyberSource\Model\PtsV2CreateOrderPost201Response createOrder($createOrderRequest)
13+
14+
Create an Order
15+
16+
A create order request enables you to send the itemized details along with the order. This API can be used by merchants initiating their transactions with the create order API.
17+
18+
### Example
19+
```php
20+
<?php
21+
require_once(__DIR__ . '/vendor/autoload.php');
22+
23+
$api_instance = new CyberSource\Api\OrdersApi();
24+
$createOrderRequest = new \CyberSource\Model\CreateOrderRequest(); // \CyberSource\Model\CreateOrderRequest |
25+
26+
try {
27+
$result = $api_instance->createOrder($createOrderRequest);
28+
print_r($result);
29+
} catch (Exception $e) {
30+
echo 'Exception when calling OrdersApi->createOrder: ', $e->getMessage(), PHP_EOL;
31+
}
32+
?>
33+
```
34+
35+
### Parameters
36+
37+
Name | Type | Description | Notes
38+
------------- | ------------- | ------------- | -------------
39+
**createOrderRequest** | [**\CyberSource\Model\CreateOrderRequest**](../Model/CreateOrderRequest.md)| |
40+
41+
### Return type
42+
43+
[**\CyberSource\Model\PtsV2CreateOrderPost201Response**](../Model/PtsV2CreateOrderPost201Response.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/hal+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+
56+
# **updateOrder**
57+
> \CyberSource\Model\PtsV2UpdateOrderPatch201Response updateOrder($id, $updateOrderRequest)
58+
59+
Update an Order
60+
61+
This API can be used in two flavours - for updating the order as well as saving the order.
62+
63+
### Example
64+
```php
65+
<?php
66+
require_once(__DIR__ . '/vendor/autoload.php');
67+
68+
$api_instance = new CyberSource\Api\OrdersApi();
69+
$id = "id_example"; // string | The ID returned from the original create order response.
70+
$updateOrderRequest = new \CyberSource\Model\UpdateOrderRequest(); // \CyberSource\Model\UpdateOrderRequest |
71+
72+
try {
73+
$result = $api_instance->updateOrder($id, $updateOrderRequest);
74+
print_r($result);
75+
} catch (Exception $e) {
76+
echo 'Exception when calling OrdersApi->updateOrder: ', $e->getMessage(), PHP_EOL;
77+
}
78+
?>
79+
```
80+
81+
### Parameters
82+
83+
Name | Type | Description | Notes
84+
------------- | ------------- | ------------- | -------------
85+
**id** | **string**| The ID returned from the original create order response. |
86+
**updateOrderRequest** | [**\CyberSource\Model\UpdateOrderRequest**](../Model/UpdateOrderRequest.md)| |
87+
88+
### Return type
89+
90+
[**\CyberSource\Model\PtsV2UpdateOrderPatch201Response**](../Model/PtsV2UpdateOrderPatch201Response.md)
91+
92+
### Authorization
93+
94+
No authorization required
95+
96+
### HTTP request headers
97+
98+
- **Content-Type**: application/json;charset=utf-8
99+
- **Accept**: application/hal+json;charset=utf-8
100+
101+
[[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)
102+

docs/Model/Boardingv1registrationsOrganizationInformationKYC.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**whenIsCustomerCharged** | **string** | |
6+
**whenIsCustomerCharged** | **string** | Possible values: - ONETIMEBEFORE - ONETIMEAFTER - OTHER |
77
**whenIsCustomerChargedDescription** | **string** | | [optional]
88
**offerSubscriptions** | **bool** | |
99
**monthlySubscriptionPercent** | **float** | | [optional]
1010
**quarterlySubscriptionPercent** | **float** | | [optional]
1111
**semiAnnualSubscriptionPercent** | **float** | | [optional]
1212
**annualSubscriptionPercent** | **float** | | [optional]
13-
**timeToProductDelivery** | **string** | |
13+
**timeToProductDelivery** | **string** | Possible values: - INSTANT - UPTO2 - UPTO5 - UPTO10 - GREATERTHAN10 |
1414
**estimatedMonthlySales** | **float** | |
1515
**averageOrderAmount** | **float** | |
1616
**largestExpectedOrderAmount** | **float** | |

docs/Model/Boardingv1registrationsOrganizationInformationKYCDepositBankAccount.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**accountHolderName** | **string** | |
7-
**accountType** | **string** | |
7+
**accountType** | **string** | Possible values: - checking - savings - corporatechecking - corporatesavings |
88
**accountRoutingNumber** | **string** | |
99
**accountNumber** | **string** | |
1010

docs/Model/CardProcessingConfigCommon.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**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]
8-
**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]
8+
**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; Possible values: - PRE - FINAL - UNDEFINED | [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]
1010
**enablePartialAuth** | **bool** | Allow merchants to accept partial authorization approvals. Applicable for Elavon Americas (elavonamericas), VPC, GPX (gpx), FDI Global (fdiglobal), FDC Nashville (smartfdc), GPN (gpn), TSYS (tsys), American Express Direct (amexdirect), Paymentech Tampa (paymentechtampa) 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;American Express Direct&lt;/td&gt;&lt;td&gt;cnp, cp, hybrid&lt;/td&gt;&lt;td&gt;No&lt;/td&gt;&lt;td&gt;No&lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; | [optional]
1111
**merchantCategoryCode** | **string** | Indicates type of business product or service of the merchant. Applicable for Chase Paymentech Salem (chasepaymentechsalem), FDI Global (fdiglobal), RUPAY, Elavon Americas (elavonamericas), American Express Direct (amexdirect), CMCIC (cmcic), GPX (gpx), VPC, TSYS (tsys), EFTPOS, CUP, Paymentech Tampa (paymentechtampa), CB2A, Barclays (barclays2), Prisma (prisma) and GPN (gpn) 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;Min. Length&lt;/th&gt;&lt;th&gt;Max. Length&lt;/th&gt;&lt;th&gt;Regex&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt; &lt;tr&gt;&lt;td&gt;Barclays&lt;/td&gt;&lt;td&gt;cnp&lt;/td&gt;&lt;td&gt;No&lt;/td&gt;&lt;td&gt;4&lt;/td&gt;&lt;td&gt;4&lt;/td&gt;&lt;td&gt;^[0-9]+$&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;American Express Direct&lt;/td&gt;&lt;td&gt;cnp, cp, hybrid&lt;/td&gt;&lt;td&gt;Yes&lt;/td&gt;&lt;td&gt;4&lt;/td&gt;&lt;td&gt;4&lt;/td&gt;&lt;td&gt;^[0-9]+$&lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; | [optional]

docs/Model/CardProcessingConfigCommonProcessors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Name | Type | Description | Notes
3232
**enableAutoAuthReversalAfterVoid** | **bool** | Enables to meet the Visa mandate requirements to reverse unused authorizations, benefitting the customer by releasing the hold on unused credit card funds. Applicable for CB2A, Elavon Americas (elavonamericas), Six (six), VPC and American Express Direct (amexdirect) 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;American Express Direct&lt;/td&gt;&lt;td&gt;cp, cnp, hybrid&lt;/td&gt;&lt;td&gt;No&lt;/td&gt;&lt;td&gt;No&lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; | [optional]
3333
**enableExpresspayPanTranslation** | **bool** | When this is enabled, authorization responses from American Express expresspay transactions include the Primary Account Number (PAN) and expiration date of the card. Applicable for American Express Direct (amexdirect) processor. | [optional]
3434
**enableCreditAuth** | **bool** | Authorizes a credit. Reduces refund chargebacks and prevents customers from seeing the online update for credits which are otherwise offline settlements. | [optional]
35-
**industryCode** | **string** | Field used to identify the industry type of the merchant submitting the authorization request. Valid values: &#x60;0&#x60; – unknown or unsure &#x60;A&#x60; – auto rental (EMV supported) &#x60;B&#x60; – bank/financial institution (EMV supported) &#x60;D&#x60; – direct marketing &#x60;F&#x60; – food/restaurant (EMV supported) &#x60;G&#x60; – grocery store/super market (EMV supported) &#x60;H&#x60; – hotel (EMV supported) &#x60;L&#x60; – limited amount terminal (EMV supported) &#x60;O&#x60; – oil company/automated fueling system (EMV supported) &#x60;P&#x60; – passenger transport (EMV supported) &#x60;R&#x60; – retail (EMV supported) Applicable for TSYS (tsys), RUPAY and Elavon Americas (elavonamericas) processors. | [optional]
35+
**industryCode** | **string** | Field used to identify the industry type of the merchant submitting the authorization request. Valid values: &#x60;0&#x60; – unknown or unsure &#x60;A&#x60; – auto rental (EMV supported) &#x60;B&#x60; – bank/financial institution (EMV supported) &#x60;D&#x60; – direct marketing &#x60;F&#x60; – food/restaurant (EMV supported) &#x60;G&#x60; – grocery store/super market (EMV supported) &#x60;H&#x60; – hotel (EMV supported) &#x60;L&#x60; – limited amount terminal (EMV supported) &#x60;O&#x60; – oil company/automated fueling system (EMV supported) &#x60;P&#x60; – passenger transport (EMV supported) &#x60;R&#x60; – retail (EMV supported) Applicable for TSYS (tsys), RUPAY and Elavon Americas (elavonamericas) processors. Possible values: - 0 - A - B - D - F - G - H - L - O - P - R | [optional]
3636
**sendAmexLevel2Data** | **bool** | Field that indicates whether merchant will send level 2 data for Amex cards. Applicable for TSYS (tsys) processor. | [optional]
3737
**softDescriptorType** | **string** | A soft descriptor is a text, rendered on a cardholder&#39;s statement, describing a particular product or service, purchased by the cardholder. Descriptors are intended to help the cardholder identify the products or services purchased. Valid values: &#x60;1&#x60; - trans_ref_no &#x60;2&#x60; - merchant_descriptor &#x60;3&#x60; - trans_ref_no and merchant_descriptor Applicable for TSYS (tsys) processor. | [optional]
3838
**vitalNumber** | **string** | V-number provided by TSYS info. The leading &#x60;V&#x60; must be replaced by a &#x60;7&#x60;. For example, replace &#x60;V1234567&#x60; with &#x60;71234567&#x60;. Applicable for TSYS (tsys) processor. | [optional]

docs/Model/CreateOrderRequest.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# CreateOrderRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**clientReferenceInformation** | [**\CyberSource\Model\Ptsv2intentsClientReferenceInformation**](Ptsv2intentsClientReferenceInformation.md) | | [optional]
7+
**processingInformation** | [**\CyberSource\Model\Ptsv2intentsProcessingInformation**](Ptsv2intentsProcessingInformation.md) | | [optional]
8+
**merchantInformation** | [**\CyberSource\Model\Ptsv2intentsMerchantInformation**](Ptsv2intentsMerchantInformation.md) | | [optional]
9+
**paymentInformation** | [**\CyberSource\Model\Ptsv2intentsPaymentInformation**](Ptsv2intentsPaymentInformation.md) | | [optional]
10+
**orderInformation** | [**\CyberSource\Model\Ptsv2intentsOrderInformation**](Ptsv2intentsOrderInformation.md) | | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

docs/Model/GenerateCaptureContextRequest.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**targetOrigins** | **string[]** | The merchant origin domain (e.g. https://example.com) used to initiate microform Integration. Required to comply with CORS and CSP standards. | [optional]
7-
**allowedCardNetworks** | **string[]** | | [optional]
8-
**clientVersion** | **string** | | [optional]
6+
**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; ] | [optional]
7+
**allowedCardNetworks** | **string[]** | The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MAESTRO - MASTERCARD - AMEX - DISCOVER - DINERSCLUB - JCB - CUP - CARTESBANCAIRES - CARNET | [optional]
8+
**clientVersion** | **string** | Specify the version of Microform that you want to use. | [optional]
99
**checkoutApiInitialization** | [**\CyberSource\Model\Microformv2sessionsCheckoutApiInitialization**](Microformv2sessionsCheckoutApiInitialization.md) | | [optional]
1010

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

0 commit comments

Comments
 (0)