Skip to content

Commit 046935d

Browse files
gnongsiegnongsie
authored
Merge pull request #53 from CyberSource/022021
February-March 2021 Release
2 parents cb59170 + 622e1c9 commit 046935d

File tree

64 files changed

+704
-387
lines changed

Some content is hidden

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

64 files changed

+704
-387
lines changed

‎README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,24 @@ Additionally, you can find details and examples of how our API is structured in
4848

4949
The API Reference Guide provides examples of what information is needed for a particular request and how that information would be formatted. Using those examples, you can easily determine what methods would be necessary to include that information in a request using this SDK.
5050

51+
## MetaKey Support
52+
53+
A Meta Key is a single key that can be used by one, some, or all merchants (or accounts, if created by a Portfolio user) in the portfolio.
54+
55+
The Portfolio or Parent Account owns the key and is considered the transaction submitter when a Meta Key is used, while the merchant owns the transaction.
56+
57+
MIDs continue to be able to create keys for themselves, even if a Meta Key is generated.
58+
59+
Further information on MetaKey can be found in [New Business Center User Guide](https://developer.cybersource.com/library/documentation/dev_guides/Business_Center/New_Business_Center_User_Guide.pdf).
60+
5161
### Switching between the sandbox environment and the production environment
5262
Cybersource maintains a complete sandbox environment for testing and development purposes. This sandbox environment is an exact duplicate of our production environment with the transaction authorization and settlement process simulated. By default, this SDK is configured to communicate with the sandbox environment. To switch to the production environment, set the `runEnvironment` property in the SDK Configuration. See our sample at https://github.com/CyberSource/cybersource-rest-samples-ruby/blob/master/data/Configuration.rb
5363

5464
```Ruby
55-
# For TESTING use
56-
runEnvironment='cybersource.environment.sandbox'
57-
# For PRODUCTION use
58-
# runEnvironment='cybersource.environment.production'
65+
# For TESTING use
66+
runEnvironment='cybersource.environment.sandbox'
67+
# For PRODUCTION use
68+
# runEnvironment='cybersource.environment.production'
5969
```
6070

6171
API credentials are different for each environment, so be sure to switch to the appropriate credentials when switching environments.

‎cybersource_rest_client.gemspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ require "cybersource_rest_client/version"
1717

1818
Gem::Specification.new do |s|
1919
s.name = "cybersource_rest_client"
20-
s.version = "0.0.27"
20+
s.version = "0.0.28"
2121
s.platform = Gem::Platform::RUBY
2222
s.authors = ["CyberSource"]
2323
s.email = ["[email protected]"]

‎docs/CheckPayerAuthEnrollmentRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**client_reference_information** | [**Riskv1authenticationsetupsClientReferenceInformation**](Riskv1authenticationsetupsClientReferenceInformation.md) | | [optional]
6+
**client_reference_information** | [**Riskv1decisionsClientReferenceInformation**](Riskv1decisionsClientReferenceInformation.md) | | [optional]
77
**order_information** | [**Riskv1authenticationsOrderInformation**](Riskv1authenticationsOrderInformation.md) | | [optional]
88
**payment_information** | [**Riskv1authenticationsPaymentInformation**](Riskv1authenticationsPaymentInformation.md) | | [optional]
99
**processing_information** | [**Riskv1authenticationsetupsProcessingInformation**](Riskv1authenticationsetupsProcessingInformation.md) | | [optional]

‎docs/FraudMarkingActionRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**risk_information** | [**Riskv1decisionsidmarkingRiskInformation**](Riskv1decisionsidmarkingRiskInformation.md) | | [optional]
7+
**client_reference_information** | [**Riskv1decisionsClientReferenceInformation**](Riskv1decisionsClientReferenceInformation.md) | | [optional]
78

89

‎docs/Kmsv2keyssymClientReferenceInformation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value. | [optional]
77
**comments** | **String** | Comments | [optional]
8-
**partner** | [**Vasv2taxClientReferenceInformationPartner**](Vasv2taxClientReferenceInformationPartner.md) | | [optional]
8+
**partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional]
99

1010

‎docs/PayerAuthSetupRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**client_reference_information** | [**Riskv1authenticationsetupsClientReferenceInformation**](Riskv1authenticationsetupsClientReferenceInformation.md) | | [optional]
6+
**client_reference_information** | [**Riskv1decisionsClientReferenceInformation**](Riskv1decisionsClientReferenceInformation.md) | | [optional]
77
**payment_information** | [**Riskv1authenticationsetupsPaymentInformation**](Riskv1authenticationsetupsPaymentInformation.md) | | [optional]
88
**processing_information** | [**Riskv1authenticationsetupsProcessingInformation**](Riskv1authenticationsetupsProcessingInformation.md) | | [optional]
99
**token_information** | [**Riskv1authenticationsetupsTokenInformation**](Riskv1authenticationsetupsTokenInformation.md) | | [optional]

‎docs/PtsV2IncrementalAuthorizationPatch201ResponseErrorInformation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**reason** | **String** | The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION - DECISION_PROFILE_REJECT - SCORE_EXCEEDS_THRESHOLD - PENDING_AUTHENTICATION | [optional]
6+
**reason** | **String** | The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION - DECISION_PROFILE_REJECT - SCORE_EXCEEDS_THRESHOLD - CONSUMER_AUTHENTICATION_REQUIRED | [optional]
77
**message** | **String** | The detail message related to the status and reason listed above. | [optional]
88
**details** | [**Array<PtsV2PaymentsPost201ResponseErrorInformationDetails>**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional]
99

‎docs/PtsV2PaymentsPost201ResponseRiskInformationInfoCodes.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**velocity** | **Array<String>** | List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules. Returned by Decision Manager service. | [optional]
7-
**address** | **Array<String>** | Indicates a mismatch between the customer’s billing and shipping addresses. Returned by scoring service. | [optional]
8-
**customer_list** | **Array<String>** | Indicates that customer information is associated with transactions that are either on the negative or the positive list. Returned by scoring service. | [optional]
9-
**identity_change** | **Array<String>** | Indicates excessive identity changes. The threshold is variable depending on the identity elements being compared. This field can contain one or more information codes, separated by carets (^). Returned by scoring service. | [optional]
10-
**internet** | **Array<String>** | Indicates a problem with the customer’s email address, IP address, or billing address. Returned by scoring service. | [optional]
11-
**phone** | **Array<String>** | Indicates a problem with the customer’s phone number. Returned by scoring service. | [optional]
12-
**suspicious** | **Array<String>** | Indicates that the customer provided potentially suspicious information. Returned by scoring service. | [optional]
13-
**global_velocity** | **Array<String>** | Indicates that the customer has a high purchase frequency. Returned by scoring service. | [optional]
6+
**velocity** | **Array<String>** | List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules. | [optional]
7+
**address** | **Array<String>** | Indicates a mismatch between the customer’s billing and shipping addresses. | [optional]
8+
**customer_list** | **Array<String>** | Indicates that customer information is associated with transactions that are either on the negative or the positive list. | [optional]
9+
**device_behavior** | **Array<String>** | Indicates the device behavior information code(s) returned from device fingerprinting. | [optional]
10+
**identity_change** | **Array<String>** | Indicates excessive identity changes. The threshold is variable depending on the identity elements being compared. | [optional]
11+
**internet** | **Array<String>** | Indicates a problem with the customer’s email address, IP address, or billing address. | [optional]
12+
**phone** | **Array<String>** | Indicates a problem with the customer’s phone number. | [optional]
13+
**suspicious** | **Array<String>** | Indicates that the customer provided potentially suspicious information. | [optional]
14+
**global_velocity** | **Array<String>** | Indicates that the customer has a high purchase frequency. | [optional]
1415

1516

‎docs/RiskV1AddressVerificationsPost201Response.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**submit_time_local** | **String** | Time that the transaction was submitted in local time. | [optional]
1010
**status** | **String** | The status for the call can be: - COMPLETED - INVALID_REQUEST - DECLINED | [optional]
1111
**message** | **String** | The message describing the reason of the status. Value can be - Apartment number missing or not found. - Insufficient address information. - House/Box number not found on street. - Multiple address matches were found. - P.O. Box identifier not found or out of range. - Route service identifier not found or out of range. - Street name not found in Postal code. - Postal code not found in database. - Unable to verify or correct address. - Multiple addres matches were found (international) - Address match not found (no reason given) - Unsupported character set | [optional]
12-
**client_reference_information** | [**PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation**](PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation.md) | | [optional]
12+
**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional]
1313
**address_verification_information** | [**RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation**](RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation.md) | | [optional]
1414
**error_information** | [**RiskV1AddressVerificationsPost201ResponseErrorInformation**](RiskV1AddressVerificationsPost201ResponseErrorInformation.md) | | [optional]
1515

‎docs/RiskV1AuthenticationResultsPost201Response.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**submit_time_local** | **String** | Time that the transaction was submitted in local time. | [optional]
1010
**status** | **String** | The status for payerAuthentication 201 enroll and validate calls. Possible values are: - `AUTHENTICATION_SUCCESSFUL` - `PENDING_AUTHENTICATION` - `INVALID_REQUEST` - `AUTHENTICATION_FAILED` | [optional]
1111
**message** | **String** | The message describing the reason of the status. Value is: - The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction. | [optional]
12-
**client_reference_information** | [**PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation**](PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation.md) | | [optional]
12+
**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional]
1313
**consumer_authentication_information** | [**RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation**](RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md) | | [optional]
1414
**error_information** | [**RiskV1AuthenticationsPost201ResponseErrorInformation**](RiskV1AuthenticationsPost201ResponseErrorInformation.md) | | [optional]
1515

‎docs/RiskV1AuthenticationSetupsPost201Response.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
**submit_time_utc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **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. Returned by authorization service. #### PIN debit Time when the PIN debit credit, PIN debit purchase or PIN debit reversal was requested. Returned by PIN debit credit, PIN debit purchase or PIN debit reversal. | [optional]
99
**status** | **String** | The status for payerAuthentication 201 setup calls. Possible value is: - COMPLETED - FAILED | [optional]
1010
**consumer_authentication_information** | [**RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation**](RiskV1AuthenticationSetupsPost201ResponseConsumerAuthenticationInformation.md) | | [optional]
11+
**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional]
1112
**error_information** | [**RiskV1AuthenticationSetupsPost201ResponseErrorInformation**](RiskV1AuthenticationSetupsPost201ResponseErrorInformation.md) | | [optional]
1213

1314

‎docs/RiskV1AuthenticationsPost201Response.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**submit_time_local** | **String** | Time that the transaction was submitted in local time. | [optional]
1010
**status** | **String** | The status for payerAuthentication 201 enroll and validate calls. Possible values are: - `AUTHENTICATION_SUCCESSFUL` - `PENDING_AUTHENTICATION` - `INVALID_REQUEST` - `AUTHENTICATION_FAILED` | [optional]
1111
**message** | **String** | The message describing the reason of the status. Value is: - The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction. | [optional]
12-
**client_reference_information** | [**PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation**](PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation.md) | | [optional]
12+
**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional]
1313
**order_information** | [**RiskV1DecisionsPost201ResponseOrderInformation**](RiskV1DecisionsPost201ResponseOrderInformation.md) | | [optional]
1414
**consumer_authentication_information** | [**RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation**](RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md) | | [optional]
1515
**error_information** | [**RiskV1AuthenticationsPost201ResponseErrorInformation**](RiskV1AuthenticationsPost201ResponseErrorInformation.md) | | [optional]

‎docs/RiskV1AuthenticationsPost201ResponseErrorInformation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**reason** | **String** | The reason of the status. Possible values are: - `INVALID_MERCHANT_CONFIGURATION` - `PENDING_AUTHENTICATION` - `AUTHENTICATION_FAILED` | [optional]
6+
**reason** | **String** | The reason of the status. Possible values are: - `INVALID_MERCHANT_CONFIGURATION` - `CONSUMER_AUTHENTICATION_REQUIRED` - `CONSUMER_AUTHENTICATION_FAILED` - `AUTHENTICATION_FAILED` | [optional]
77
**message** | **String** | The detail message related to the status and reason listed above. | [optional]
88
**details** | [**Array<PtsV2PaymentsPost201ResponseErrorInformationDetails>**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional]
99

‎docs/RiskV1DecisionsPost201Response.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
**status** | **String** | The status of the submitted transaction. Possible values: - `ACCEPTED` - `REJECTED` - `PENDING_REVIEW` - `DECLINED` - `PENDING_AUTHENTICATION` - `INVALID_REQUEST` - `AUTHENTICATION_FAILED` - `CHALLENGE` | [optional]
1111
**risk_information** | [**PtsV2PaymentsPost201ResponseRiskInformation**](PtsV2PaymentsPost201ResponseRiskInformation.md) | | [optional]
1212
**payment_information** | [**RiskV1DecisionsPost201ResponsePaymentInformation**](RiskV1DecisionsPost201ResponsePaymentInformation.md) | | [optional]
13-
**client_reference_information** | [**PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation**](PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation.md) | | [optional]
13+
**client_reference_information** | [**RiskV1DecisionsPost201ResponseClientReferenceInformation**](RiskV1DecisionsPost201ResponseClientReferenceInformation.md) | | [optional]
1414
**order_information** | [**RiskV1DecisionsPost201ResponseOrderInformation**](RiskV1DecisionsPost201ResponseOrderInformation.md) | | [optional]
1515
**consumer_authentication_information** | [**RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation**](RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md) | | [optional]
1616
**error_information** | [**RiskV1DecisionsPost201ResponseErrorInformation**](RiskV1DecisionsPost201ResponseErrorInformation.md) | | [optional]

‎docs/Riskv1addressverificationsClientReferenceInformation.md ‎docs/RiskV1DecisionsPost201ResponseClientReferenceInformation.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# CyberSource::Riskv1addressverificationsClientReferenceInformation
1+
# CyberSource::RiskV1DecisionsPost201ResponseClientReferenceInformation
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**code** | **String** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. |
6+
**code** | **String** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional]
77
**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional]
8+
**partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional]
89

910

0 commit comments

Comments
 (0)