Skip to content

Commit deb4386

Browse files
authored
Merge pull request #107 from CyberSource/june-2022-release
June SDK release
2 parents 70f7948 + cdd75eb commit deb4386

File tree

93 files changed

+3334
-183
lines changed

Some content is hidden

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

93 files changed

+3334
-183
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,39 @@ The CyberSource PHP client provides convenient access to the [CyberSource REST A
99
* Enable cURL PHP Extension
1010
* Enable JSON PHP Extension
1111
* Enable MBString PHP Extension
12-
* Enable PHP_APCU PHP Extension. You will need to download it for your platform (Windows/Linux/Mac)
12+
* Enable PHP_APCU PHP Extension. You will need to download it for your platform (Windows/Linux/Mac)
1313
* [CyberSource Account](https://developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration.html)
1414
* [CyberSource API Keys](https://prod.developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration/createCertSharedKey.html)
15-
15+
1616
## Dependencies
1717
* PHP-JWT : JWT token Generation
1818
* CURL : Http communication with the payment gateway
19-
* PHP_APCU : Caching
19+
* PHP_APCU : Caching
2020
* phpunit-5.7.25 : unit testing
2121
* phpunit-5.7.25 code coverage : Sonar coverage
2222

2323
## Installation
2424
### Composer
2525
We recommend using [`Composer`](http://getcomposer.org). *(Note: we never recommend you
26-
override the new secure-http default setting)*.
26+
override the new secure-http default setting)*.
2727
*Update your composer.json file as per the example below and then run
2828
`composer update`.*
2929

3030
```json
3131
{
3232
"require": {
3333
"php": ">=5.6",
34-
"cybersource/rest-client-php": "0.0.32"
34+
"cybersource/rest-client-php": "0.0.33"
3535
}
3636
}
3737
```
3838

3939
## Registration & Configuration
4040
Use of this SDK and the CyberSource APIs requires having an account on our system. You can find details of getting a test account and creating your keys [here](https://developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration.html)
4141

42-
Once you have your keys, simply load them into the appropriate variables in your code, as per the below sample code dealing with the authentication part of the API request.
42+
Once you have your keys, simply load them into the appropriate variables in your code, as per the below sample code dealing with the authentication part of the API request.
4343

44-
Remember this SDK is for use in server-side PHP applications that access the CyberSource REST API and credentials should always be securely stored and accessed appropriately.
44+
Remember this SDK is for use in server-side PHP applications that access the CyberSource REST API and credentials should always be securely stored and accessed appropriately.
4545

4646
## SDK Usage Examples and Sample Code
4747
To get started using this SDK, it's highly recommended to download our sample code repository:
@@ -67,11 +67,11 @@ Further information on MetaKey can be found in [New Business Center User Guide](
6767
## To set your API credentials for an API request, configure the following information in ExternalConfiguration.php file:
6868

6969
Create a file in your application `ExternalConfiguration.php` inside a `Resources` folder and configure the following information as per requirement similar to [**this one**](https://github.com/CyberSource/cybersource-rest-samples-php/blob/master/Resources/ExternalConfiguration.php).
70-
71-
#### For Http Signature Authentication
72-
70+
71+
#### For Http Signature Authentication
72+
7373
Configure the following information in `ExternalConfiguration.php` file
74-
74+
7575
* Authentication Type: Merchant should enter "HTTP_SIGNATURE" for HTTP authentication mechanism.
7676
* Merchant ID: Merchant will provide the merchant ID, which has taken from EBC portal.
7777
* MerchantSecretKey: Merchant will provide the secret Key value, which has taken from EBC portal.
@@ -102,7 +102,7 @@ Further information on MetaKey can be found in [New Business Center User Guide](
102102
#### For Jwt Signature Authentication
103103

104104
Configure the following information in the `ExternalConfiguration.php` file
105-
105+
106106
* Authentication Type: Merchant should enter "JWT" for JWT authentication mechanism.
107107
* Merchant ID: Merchant will provide the merchant ID, which was taken from EBC portal.
108108
* keyAlias: Alias of the Merchant ID, to be used while generating the JWT token.

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.32",
3+
"version": "0.0.33",
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/SecureFileShareApi.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ No authorization required
4949

5050
### HTTP request headers
5151

52-
- **Content-Type**: application/json;charset=utf-8
52+
- **Content-Type**: */*;charset=utf-8
5353
- **Accept**: application/xml, text/csv, application/pdf
5454

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

101101
### HTTP request headers
102102

103-
- **Content-Type**: application/json;charset=utf-8
103+
- **Content-Type**: */*;charset=utf-8
104104
- **Accept**: application/hal+json
105105

106106
[[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)
107-

docs/Model/PtsV2PaymentsPost201Response.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
1515
**issuerInformation** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponseIssuerInformation**](PtsV2PaymentsPost201ResponseIssuerInformation.md) | | [optional]
1616
**paymentAccountInformation** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponsePaymentAccountInformation**](PtsV2PaymentsPost201ResponsePaymentAccountInformation.md) | | [optional]
1717
**paymentInformation** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponsePaymentInformation**](PtsV2PaymentsPost201ResponsePaymentInformation.md) | | [optional]
18+
**paymentInsightsInformation** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponsePaymentInsightsInformation**](PtsV2PaymentsPost201ResponsePaymentInsightsInformation.md) | | [optional]
1819
**orderInformation** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponseOrderInformation**](PtsV2PaymentsPost201ResponseOrderInformation.md) | | [optional]
1920
**pointOfSaleInformation** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponsePointOfSaleInformation**](PtsV2PaymentsPost201ResponsePointOfSaleInformation.md) | | [optional]
2021
**installmentInformation** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponseInstallmentInformation**](PtsV2PaymentsPost201ResponseInstallmentInformation.md) | | [optional]

docs/Model/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**acsUrl** | **string** | URL for the card-issuing bank’s authentication form that you receive when the card is enrolled. The value can be very large. | [optional]
1010
**authenticationPath** | **string** | Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer’s authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) | [optional]
1111
**authorizationPayload** | **string** | The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow | [optional]
12-
**authenticationTransactionId** | **string** | Payer authentication transaction identifier passed to link the check enrollment and validate authentication messages. | [optional]
12+
**authenticationTransactionId** | **string** | Payer authentication transaction identifier is used to link the check enrollment and validate authentication messages. For Rupay, this field should be passed as request only for Resend OTP use case. | [optional]
1313
**cardholderMessage** | **string** | Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder. For example, “Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.”. The Issuing Bank can optionally support this value. | [optional]
1414
**cavv** | **string** | Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor. | [optional]
1515
**cavvAlgorithm** | **string** | Field that is returned only when the CAVV is generated, which occurs when paresStatus contains the values Y (successful authentication) or A (attempted authentication). If you use the ATOS processor, send the value of this field in the `cavv_algorithm` request field of the authorization service. This field contains one of these values: - `2`: Visa, American Express, JCB, Diners Club, and Discover - `3`: Mastercard | [optional]

docs/Model/PtsV2PaymentsPost201ResponseIssuerInformation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
**discretionaryData** | **string** | Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
88
**countrySpecificDiscretionaryData** | **string** | Data defined by the issuer. This national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan. This subfield contains the Katakana text to be printed on the receipt. For details, see `jpo_issuer_message` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
99
**responseCode** | **string** | Additional authorization code that must be printed on the receipt when returned by the processor. This value is generated by the processor and is returned only for a successful transaction. This reply field is supported only for these processors: - FDC Nashville Global - SIX | [optional]
10+
**responseRaw** | **string** | issuerInformation.responseRaw is the raw processor auth response returned to merchant in CYBS auth response if auth request includes \"processingInformation.isReturnAuthRecordEnabled=true\". If supported by the gateway code, it is available to merchants who auth through CYBS and run their own settlement processing. | [optional]
1011

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# PtsV2PaymentsPost201ResponsePaymentInsightsInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**responseInsights** | [**\CyberSource\Model\PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights**](PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights.md) | | [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+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**category** | **string** | Categorization of response message from processor Possible Values: - `APPROVED` - `ISSUER_WILL_NEVER_APPROVE` - `ISSUER_CANT_APPROVE_AT_THIS_TIME` - `ISSUER_CANT_APPROVE_WITH_THESE_DETAILS` - `GENERIC_ERROR` - `OTHERS` - `MATCH_NOT_FOUND` | [optional]
7+
**categoryCode** | **string** | Categorization Code of response message from processor Possible Values: - `01` : Issuer Will Never Approve - `02` : Issuer Can't Approve at this Time - `03` : Issuer Can't Approve with these Details - `04` : Generic Error - `98` : Others - `99` : Payment Insights Response Category Match Not Found | [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+

0 commit comments

Comments
 (0)