Skip to content

Commit 7679567

Browse files
gaubansagaubansa
authored
Merge pull request #162 from CyberSource/july24-release
july spec changes
2 parents 9b0116f + 7aa53cc commit 7679567

File tree

326 files changed

+11711
-2204
lines changed

Some content is hidden

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

326 files changed

+11711
-2204
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.52"
32+
"cybersource/rest-client-php": "0.0.53"
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.52",
3+
"version": "0.0.53",
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/BinLookupApi.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# CyberSource\BinLookupApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getAccountInfo**](BinLookupApi.md#getAccountInfo) | **POST** /bin/v1/binlookup | BIN Lookup API
8+
9+
10+
# **getAccountInfo**
11+
> \CyberSource\Model\InlineResponse2011 getAccountInfo($createBinLookupRequest)
12+
13+
BIN Lookup API
14+
15+
The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources. This service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses with a flexible choice of inputs such as primary account number (PAN), network token from major networks which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS). Currently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant.
16+
17+
### Example
18+
```php
19+
<?php
20+
require_once(__DIR__ . '/vendor/autoload.php');
21+
22+
$api_instance = new CyberSource\Api\BinLookupApi();
23+
$createBinLookupRequest = new \CyberSource\Model\CreateBinLookupRequest(); // \CyberSource\Model\CreateBinLookupRequest |
24+
25+
try {
26+
$result = $api_instance->getAccountInfo($createBinLookupRequest);
27+
print_r($result);
28+
} catch (Exception $e) {
29+
echo 'Exception when calling BinLookupApi->getAccountInfo: ', $e->getMessage(), PHP_EOL;
30+
}
31+
?>
32+
```
33+
34+
### Parameters
35+
36+
Name | Type | Description | Notes
37+
------------- | ------------- | ------------- | -------------
38+
**createBinLookupRequest** | [**\CyberSource\Model\CreateBinLookupRequest**](../Model/CreateBinLookupRequest.md)| |
39+
40+
### Return type
41+
42+
[**\CyberSource\Model\InlineResponse2011**](../Model/InlineResponse2011.md)
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+

‎docs/Api/CreateNewWebhooksApi.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Method | HTTP request | Description
1010

1111

1212
# **createWebhookSubscription**
13-
> \CyberSource\Model\InlineResponse2013 createWebhookSubscription($createWebhookRequest)
13+
> \CyberSource\Model\InlineResponse2014 createWebhookSubscription($createWebhookRequest)
1414
1515
Create a Webhook
1616

@@ -41,7 +41,7 @@ Name | Type | Description | Notes
4141

4242
### Return type
4343

44-
[**\CyberSource\Model\InlineResponse2013**](../Model/InlineResponse2013.md)
44+
[**\CyberSource\Model\InlineResponse2014**](../Model/InlineResponse2014.md)
4545

4646
### Authorization
4747

@@ -100,7 +100,7 @@ No authorization required
100100
[[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)
101101

102102
# **saveSymEgressKey**
103-
> \CyberSource\Model\InlineResponse2012 saveSymEgressKey($vCSenderOrganizationId, $vCPermissions, $vCCorrelationId, $saveSymEgressKey)
103+
> \CyberSource\Model\InlineResponse2013 saveSymEgressKey($vCSenderOrganizationId, $vCPermissions, $vCCorrelationId, $saveSymEgressKey)
104104
105105
Create Webhook Security Keys
106106

@@ -137,7 +137,7 @@ Name | Type | Description | Notes
137137

138138
### Return type
139139

140-
[**\CyberSource\Model\InlineResponse2012**](../Model/InlineResponse2012.md)
140+
[**\CyberSource\Model\InlineResponse2013**](../Model/InlineResponse2013.md)
141141

142142
### Authorization
143143

‎docs/Api/ManageWebhooksApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ No authorization required
150150
[[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)
151151

152152
# **saveAsymEgressKey**
153-
> \CyberSource\Model\InlineResponse2014 saveAsymEgressKey($vCSenderOrganizationId, $vCPermissions, $saveAsymEgressKey, $vCCorrelationId)
153+
> \CyberSource\Model\InlineResponse2015 saveAsymEgressKey($vCSenderOrganizationId, $vCPermissions, $saveAsymEgressKey, $vCCorrelationId)
154154
155155
Message Level Encryption
156156

@@ -187,7 +187,7 @@ Name | Type | Description | Notes
187187

188188
### Return type
189189

190-
[**\CyberSource\Model\InlineResponse2014**](../Model/InlineResponse2014.md)
190+
[**\CyberSource\Model\InlineResponse2015**](../Model/InlineResponse2015.md)
191191

192192
### Authorization
193193

‎docs/Api/MerchantBoardingApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ No authorization required
5454
[[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)
5555

5656
# **postRegistration**
57-
> \CyberSource\Model\InlineResponse2011 postRegistration($postRegistrationBody, $vCIdempotencyId)
57+
> \CyberSource\Model\InlineResponse2012 postRegistration($postRegistrationBody, $vCIdempotencyId)
5858
5959
Create a boarding registration
6060

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

8888
### Return type
8989

90-
[**\CyberSource\Model\InlineResponse2011**](../Model/InlineResponse2011.md)
90+
[**\CyberSource\Model\InlineResponse2012**](../Model/InlineResponse2012.md)
9191

9292
### Authorization
9393

‎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-
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
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). 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/TssV2TransactionsPost400Response.md ‎docs/Model/BinLookupv400Response.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TssV2TransactionsPost400Response
1+
# BinLookupv400Response
22

33
## Properties
44
Name | Type | Description | Notes

‎docs/Model/Binv1binlookupClientReferenceInformation.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Binv1binlookupClientReferenceInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**partner** | [**\CyberSource\Model\Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional]
7+
**applicationName** | **string** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional]
8+
**applicationVersion** | **string** | Version of the CyberSource application or integration used for a transaction. | [optional]
9+
**applicationUser** | **string** | The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/Model/Binv1binlookupPaymentInformation.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Binv1binlookupPaymentInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**card** | [**\CyberSource\Model\Binv1binlookupPaymentInformationCard**](Binv1binlookupPaymentInformationCard.md) | | [optional]
7+
**customer** | [**\CyberSource\Model\GetAllSubscriptionsResponsePaymentInformationCustomer**](GetAllSubscriptionsResponsePaymentInformationCustomer.md) | | [optional]
8+
**paymentInstrument** | [**\CyberSource\Model\Ptsv2paymentsPaymentInformationPaymentInstrument**](Ptsv2paymentsPaymentInformationPaymentInstrument.md) | | [optional]
9+
**instrumentIdentifier** | [**\CyberSource\Model\Ptsv2paymentsPaymentInformationInstrumentIdentifier**](Ptsv2paymentsPaymentInformationInstrumentIdentifier.md) | | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/Model/Binv1binlookupPaymentInformationCard.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Binv1binlookupPaymentInformationCard
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**number** | **string** | The customer&#39;s payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [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/Binv1binlookupProcessingInformation.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Binv1binlookupProcessingInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**binSource** | **string** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional]
7+
**payoutOptions** | [**\CyberSource\Model\Binv1binlookupProcessingInformationPayoutOptions**](Binv1binlookupProcessingInformationPayoutOptions.md) | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/Model/Binv1binlookupProcessingInformationPayoutOptions.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Binv1binlookupProcessingInformationPayoutOptions
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**payoutInquiry** | **bool** | If &#x60;true&#x60; then provide attributes related to fund transfer/payouts. If payout information not found then response will have standard account lookup. Possible values: - true - false | [optional]
7+
**networkId** | **string** | The networks specified in this field must be a subset of the information provided during program enrollment Possible values: - 0020 : Accel/Exchange - 0024 : CU24 - 0003 : Interlink - 0016 : Maestro - 0018 : NYCE - 0027 : NYCE - 0009 : Pulse - 0017 : Pulse - 0019 : Pulse - 0008 : Star - 0010 : Star - 0011 : Star - 0012 : Star - 0015 : Star - 0002 : Visa/PLUS | [optional]
8+
**acquirerBin** | **string** | BIN under which the Funds Transfer application is registered. This must match the information provided during enrollment. | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/Model/Binv1binlookupTokenInformation.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Binv1binlookupTokenInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**jti** | **string** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [optional]
7+
**transientTokenJwt** | **string** | Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result. | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/Model/CreateBinLookupRequest.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CreateBinLookupRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**clientReferenceInformation** | [**\CyberSource\Model\Binv1binlookupClientReferenceInformation**](Binv1binlookupClientReferenceInformation.md) | | [optional]
7+
**paymentInformation** | [**\CyberSource\Model\Binv1binlookupPaymentInformation**](Binv1binlookupPaymentInformation.md) | | [optional]
8+
**tokenInformation** | [**\CyberSource\Model\Binv1binlookupTokenInformation**](Binv1binlookupTokenInformation.md) | | [optional]
9+
**processingInformation** | [**\CyberSource\Model\Binv1binlookupProcessingInformation**](Binv1binlookupProcessingInformation.md) | | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/Model/InlineResponse2002.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**integrationInformation** | [**\CyberSource\Model\InlineResponse2002IntegrationInformation**](InlineResponse2002IntegrationInformation.md) | | [optional]
88
**organizationInformation** | [**\CyberSource\Model\Boardingv1registrationsOrganizationInformation**](Boardingv1registrationsOrganizationInformation.md) | | [optional]
99
**productInformation** | [**\CyberSource\Model\Boardingv1registrationsProductInformation**](Boardingv1registrationsProductInformation.md) | | [optional]
10-
**productInformationSetups** | [**\CyberSource\Model\InlineResponse2011ProductInformationSetups[]**](InlineResponse2011ProductInformationSetups.md) | | [optional]
10+
**productInformationSetups** | [**\CyberSource\Model\InlineResponse2012ProductInformationSetups[]**](InlineResponse2012ProductInformationSetups.md) | | [optional]
1111
**documentInformation** | [**\CyberSource\Model\Boardingv1registrationsDocumentInformation**](Boardingv1registrationsDocumentInformation.md) | | [optional]
1212
**details** | [**map[string,object[]]**](array.md) | | [optional]
1313

‎docs/Model/InlineResponse2011.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,12 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**id** | **string** | | [optional]
7-
**submitTimeUtc** | [**\DateTime**](\DateTime.md) | Time of request in UTC. &#x60;Format: YYYY-MM-DDThh:mm:ssZ&#x60; Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional]
8-
**status** | **string** | The status of Registration request Possible Values: - &#39;INITIALIZED&#39; - &#39;RECEIVED&#39; - &#39;PROCESSING&#39; - &#39;SUCCESS&#39; - &#39;FAILURE&#39; - &#39;PARTIAL&#39; | [optional]
9-
**registrationInformation** | [**\CyberSource\Model\InlineResponse2011RegistrationInformation**](InlineResponse2011RegistrationInformation.md) | | [optional]
10-
**integrationInformation** | [**\CyberSource\Model\InlineResponse2011IntegrationInformation**](InlineResponse2011IntegrationInformation.md) | | [optional]
11-
**organizationInformation** | [**\CyberSource\Model\InlineResponse2011OrganizationInformation**](InlineResponse2011OrganizationInformation.md) | | [optional]
12-
**productInformationSetups** | [**\CyberSource\Model\InlineResponse2011ProductInformationSetups[]**](InlineResponse2011ProductInformationSetups.md) | | [optional]
13-
**message** | **string** | | [optional]
14-
**details** | [**map[string,object[]]**](array.md) | | [optional]
6+
**id** | **string** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
7+
**submitTimeUtc** | **string** | Time of request in UTC. Format: &#x60;YYYY-MM-DDThh:mm:ssZ&#x60; **Example** &#x60;2016-08-11T22:47:57Z&#x60; equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The &#x60;T&#x60; separates the date and the time. The &#x60;Z&#x60; indicates UTC. Returned by Cybersource for all services. | [optional]
8+
**status** | **string** | The status of the submitted transaction. Possible values: - COMPLETED - MULTIPLE - NO MATCH | [optional]
9+
**paymentAccountInformation** | [**\CyberSource\Model\InlineResponse2011PaymentAccountInformation**](InlineResponse2011PaymentAccountInformation.md) | | [optional]
10+
**issuerInformation** | [**\CyberSource\Model\InlineResponse2011IssuerInformation**](InlineResponse2011IssuerInformation.md) | | [optional]
11+
**payoutInformation** | [**\CyberSource\Model\InlineResponse2011PayoutInformation**](InlineResponse2011PayoutInformation.md) | | [optional]
1512

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

0 commit comments

Comments
 (0)