Merge pull request #86 from CyberSource/march-2022

Updates for March 2022 Release
CyberSource · Mar 23, 2022 · 5c7a1c6 · 5c7a1c6
2 parents e9a9972 + 3774b00
commit 5c7a1c6
Show file tree

Hide file tree

Showing 36 changed files with 863 additions and 85 deletions.
diff --git a/docs/PaymentsApi.md b/docs/PaymentsApi.md
@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 Process a Payment
 
-A payment authorizes the amount for the transaction. There are a number of supported payment feature, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc..  A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-payments/GettingStarted.html).  Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation. Find more on [Authorization with Add-On Features page.](https://developer.cybersource.com/api/authorization-add-ons.html) 
+A payment authorizes the amount for the transaction. There are a number of supported payment feature, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc..  A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-payments/GettingStarted.html).  Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation. 
 
 ### Example
 ```javascript

diff --git a/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformation.md b/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformation.md
@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**approvalCode** | **String** | Authorization code. Returned only when the processor returns this value.  The length of this value depends on your processor.  Returned by authorization service.  #### PIN debit Authorization code that is returned by the processor.  Returned by PIN debit credit.  #### Elavon Encrypted Account Number Program The returned value is OFFLINE.  #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000.  | [optional] 
 **transactionId** | **String** | Processor transaction ID.  This value identifies the transaction on a host system. This value is supported only for Moneris. It contains this information:   - Terminal used to process the transaction  - Shift during which the transaction took place  - Batch number  - Transaction number within the batch  You must store this value. If you give the customer a receipt, display this value on the receipt.  Example For the value 66012345001069003:   - Terminal ID &#x3D; 66012345  - Shift number &#x3D; 001  - Batch number &#x3D; 069  - Transaction number &#x3D; 003  | [optional] 
 **forwardedAcquirerCode** | **String** | Name of the Japanese acquirer that processed the transaction. Returned only for JCN Gateway. Please contact the CyberSource Japan Support Group for more information.  | [optional] 
 **merchantNumber** | **String** | Identifier that was assigned to you by your acquirer. This value must be printed on the receipt.  #### Returned by Authorizations and Credits.  This reply field is only supported by merchants who have installed client software on their POS terminals and use these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX  | [optional] 

diff --git a/docs/Ptsv2paymentsMerchantInformationMerchantDescriptor.md b/docs/Ptsv2paymentsMerchantInformationMerchantDescriptor.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **country** | **String** | Merchant&#39;s country.  #### PIN debit Country code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This value might be displayed on the cardholder’s statement.  When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** If your business is located in the U.S. or Canada and you include this field in a request, you must also include &#x60;merchantInformation.merchantDescriptor.administrativeArea&#x60;.  Optional field for PIN debit credit or PIN debit purchase.  | [optional] 
 **postalCode** | **String** | Merchant&#39;s postal code.  #### PIN debit Postal code for your business location. This value might be displayed on the cardholder’s statement.  If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: &#x60;12345-6789&#x60;  If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: &#x60;A1B 2C3&#x60;  When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters.  **Note** This field is supported only for businesses located in the U.S. or Canada. **Important** Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your account or you can include this field in your request.  Optional field for PIN debit credit or PIN debit purchase.  | [optional] 
 **administrativeArea** | **String** | The state where the merchant is located.  #### PIN debit State code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder’s statement.  When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters.  **Note** This field is supported only for businesses located in the U.S. or Canada.  Optional field for PIN debit credit or PIN debit purchase.  | [optional] 
-**phone** | **String** | Merchnat phone as contact information for CNP transactions  | [optional] 
+**phone** | **String** | Merchant phone as contact information for CNP transactions  | [optional] 
 **url** | **String** | Address of company&#39;s website provided by merchant  | [optional] 
 
 
diff --git a/docs/TssV2TransactionsGet200Response.md b/docs/TssV2TransactionsGet200Response.md
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
 **rootId** | **String** | Contains the transaction identifier for the first transaction in the series of transactions. For example, you might send an authorization request for a payment, followed by a capture request for that payment, and then a refund request for that captured payment. Each of those requests, if successful, creates a resource that is assigned an identifier, which is returned in the response. The rootId identifies the first ID in the series, which in this case would be the ID of the original authorization. | [optional] 
 **reconciliationId** | **String** | Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response.  | [optional] 
 **merchantId** | **String** | Your CyberSource merchant ID. | [optional] 
-**status** | **String** | The status of the submitted transaction. | [optional] 
 **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] 
 **applicationInformation** | [**TssV2TransactionsGet200ResponseApplicationInformation**](TssV2TransactionsGet200ResponseApplicationInformation.md) |  | [optional] 
 **buyerInformation** | [**TssV2TransactionsGet200ResponseBuyerInformation**](TssV2TransactionsGet200ResponseBuyerInformation.md) |  | [optional] 
@@ -27,6 +26,7 @@ Name | Type | Description | Notes
 **pointOfSaleInformation** | [**TssV2TransactionsGet200ResponsePointOfSaleInformation**](TssV2TransactionsGet200ResponsePointOfSaleInformation.md) |  | [optional] 
 **riskInformation** | [**TssV2TransactionsGet200ResponseRiskInformation**](TssV2TransactionsGet200ResponseRiskInformation.md) |  | [optional] 
 **senderInformation** | [**TssV2TransactionsGet200ResponseSenderInformation**](TssV2TransactionsGet200ResponseSenderInformation.md) |  | [optional] 
+**tokenInformation** | [**TssV2TransactionsGet200ResponseTokenInformation**](TssV2TransactionsGet200ResponseTokenInformation.md) |  | [optional] 
 **links** | [**TssV2TransactionsGet200ResponseLinks**](TssV2TransactionsGet200ResponseLinks.md) |  | [optional] 
 
 
diff --git a/docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md b/docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **applicationVersion** | **String** | Version of the CyberSource application or integration used for a transaction.  | [optional] 
 **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] 
 **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] 
+**partner** | [**TssV2TransactionsGet200ResponseClientReferenceInformationPartner**](TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md) |  | [optional] 
 **comments** | **String** | Brief description of the order or any comment you wish to add to the order.  | [optional] 
 
 
diff --git a/...eddedClientReferenceInformationPartner.md → ...ponseClientReferenceInformationPartner.md b/...eddedClientReferenceInformationPartner.md → ...ponseClientReferenceInformationPartner.md
@@ -1,4 +1,4 @@
-# CyberSource.TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner
+# CyberSource.TssV2TransactionsGet200ResponseClientReferenceInformationPartner
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformation.md b/docs/TssV2TransactionsGet200ResponsePaymentInformation.md
@@ -4,10 +4,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **paymentType** | [**TssV2TransactionsGet200ResponsePaymentInformationPaymentType**](TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md) |  | [optional] 
-**customer** | [**Riskv1authenticationsetupsPaymentInformationCustomer**](Riskv1authenticationsetupsPaymentInformationCustomer.md) |  | [optional] 
+**customer** | [**TssV2TransactionsGet200ResponsePaymentInformationCustomer**](TssV2TransactionsGet200ResponsePaymentInformationCustomer.md) |  | [optional] 
 **card** | [**TssV2TransactionsGet200ResponsePaymentInformationCard**](TssV2TransactionsGet200ResponsePaymentInformationCard.md) |  | [optional] 
 **invoice** | [**TssV2TransactionsGet200ResponsePaymentInformationInvoice**](TssV2TransactionsGet200ResponsePaymentInformationInvoice.md) |  | [optional] 
 **bank** | [**TssV2TransactionsGet200ResponsePaymentInformationBank**](TssV2TransactionsGet200ResponsePaymentInformationBank.md) |  | [optional] 
 **accountFeatures** | [**TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures**](TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md) |  | [optional] 
+**paymentInstrument** | [**PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument**](PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument.md) |  | [optional] 
+**instrumentIdentifier** | [**TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier**](TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md) |  | [optional] 
+**shippingAddress** | [**PtsV2PaymentsPost201ResponseTokenInformationShippingAddress**](PtsV2PaymentsPost201ResponseTokenInformationShippingAddress.md) |  | [optional] 
 
 
diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md
@@ -0,0 +1,9 @@
+# CyberSource.TssV2TransactionsGet200ResponsePaymentInformationCustomer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerId** | **String** | Unique identifier for the legacy Secure Storage token used in the transaction. When you include this value in your request, many of the fields that are normally required for an authorization or credit become optional.  | [optional] 
+**id** | **String** | Unique identifier for the Customer token that was created as part of a bundled TOKEN_CREATE action.  | [optional] 
+
+
diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md
@@ -0,0 +1,8 @@
+# CyberSource.TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for the Instrument Identifier token that was created as part of a bundled TOKEN_CREATE action.  | [optional] 
+
+
diff --git a/docs/TssV2TransactionsGet200ResponseProcessorInformation.md b/docs/TssV2TransactionsGet200ResponseProcessorInformation.md
@@ -17,5 +17,6 @@ Name | Type | Description | Notes
 **electronicVerificationResults** | [**TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults**](TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md) |  | [optional] 
 **systemTraceAuditNumber** | **String** | This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. Returned by authorization and incremental authorization services.  #### American Express Direct  System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute.  #### CyberSource through VisaNet  System trace number that must be printed on the customer’s receipt.  | [optional] 
 **responseCodeSource** | **String** | Used by Visa only and contains the response source/reason code that identifies the source of the response decision.  | [optional] 
+**paymentAccountReferenceNumber** | **String** | Visa-generated reference number that identifies a card-present transaction for which you provided one of the following:   - Visa primary account number (PAN)  - Visa-generated token for a PAN  This reference number serves as a link to the cardholder account and to all transactions for that account. This reply field is returned only for CyberSource through VisaNet.  **Note** On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR8 - Position: 79-110 - Field: Payment Account Reference  The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks.  | [optional] 
 
 
diff --git a/docs/TssV2TransactionsGet200ResponseTokenInformation.md b/docs/TssV2TransactionsGet200ResponseTokenInformation.md
@@ -0,0 +1,11 @@
+# CyberSource.TssV2TransactionsGet200ResponseTokenInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer** | [**PtsV2PaymentsPost201ResponseTokenInformationCustomer**](PtsV2PaymentsPost201ResponseTokenInformationCustomer.md) |  | [optional] 
+**paymentInstrument** | [**PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument**](PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument.md) |  | [optional] 
+**shippingAddress** | [**PtsV2PaymentsPost201ResponseTokenInformationShippingAddress**](PtsV2PaymentsPost201ResponseTokenInformationShippingAddress.md) |  | [optional] 
+**instrumentIdentifier** | [**TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier**](TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md) |  | [optional] 
+
+
diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 **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] 
 **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] 
 **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] 
-**partner** | [**TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner**](TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md) |  | [optional] 
+**partner** | [**TssV2TransactionsGet200ResponseClientReferenceInformationPartner**](TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md) |  | [optional]