cybersource-rest-client 0.0.39 → 0.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/.idea/cybersource-rest-client-node.iml +9 -0
  2. package/.idea/jsLibraryMappings.xml +6 -0
  3. package/.idea/libraries/swagger_codegen_cli_2_3_0.xml +9 -0
  4. package/.idea/misc.xml +2 -4
  5. package/.idea/modules.xml +8 -0
  6. package/cybersource-rest-client-0.0.39.tgz +0 -0
  7. package/cybersource-rest-client-0.0.40.tgz +0 -0
  8. package/docs/AsymmetricKeyManagementApi.md +8 -8
  9. package/docs/InlineResponse4002.md +2 -1
  10. package/docs/InlineResponse502.md +12 -0
  11. package/docs/KmsV2KeysSymPost201ResponseKeyInformation.md +1 -0
  12. package/docs/MitVoidRequest.md +2 -0
  13. package/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformation.md +1 -0
  14. package/docs/Ptsv2paymentsPaymentInformationCard.md +1 -1
  15. package/docs/Ptsv2paymentsPaymentInformationPaymentTypeMethod.md +1 -1
  16. package/docs/Ptsv2paymentsPointOfSaleInformation.md +1 -0
  17. package/docs/Ptsv2paymentsProcessingInformation.md +2 -0
  18. package/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md +1 -0
  19. package/docs/Ptsv2paymentsProcessingInformationJapanPaymentOptions.md +6 -0
  20. package/docs/Ptsv2voidsProcessingInformation.md +8 -0
  21. package/docs/SecureFileShareApi.md +115 -115
  22. package/docs/TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md +1 -0
  23. package/docs/TssV2TransactionsGet200ResponsePaymentInformation.md +1 -0
  24. package/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md +1 -1
  25. package/docs/TssV2TransactionsGet200ResponsePaymentInformationFluidData.md +8 -0
  26. package/docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md +1 -0
  27. package/docs/TssV2TransactionsGet200ResponseProcessingInformation.md +1 -0
  28. package/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md +1 -1
  29. package/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md +8 -0
  30. package/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md +1 -0
  31. package/package.json +1 -1
  32. package/src/api/AsymmetricKeyManagementApi.js +9 -9
  33. package/src/api/SecureFileShareApi.js +2 -2
  34. package/src/api/SymmetricKeyManagementApi.js +4 -4
  35. package/src/authentication/core/MerchantConfig.js +3 -1
  36. package/src/authentication/logging/ExternalLoggerWrapper.js +20 -0
  37. package/src/authentication/logging/LogConfiguration.js +37 -2
  38. package/src/authentication/logging/Logger.js +20 -9
  39. package/src/authentication/util/ApiException.js +5 -0
  40. package/src/index.js +24 -4
  41. package/src/model/InlineResponse4002.js +10 -1
  42. package/src/model/InlineResponse502.js +118 -0
  43. package/src/model/KmsV2KeysSymPost201ResponseKeyInformation.js +9 -0
  44. package/src/model/MitVoidRequest.js +20 -4
  45. package/src/model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.js +9 -0
  46. package/src/model/Ptsv2paymentsPaymentInformationCard.js +1 -1
  47. package/src/model/Ptsv2paymentsPaymentInformationPaymentTypeMethod.js +1 -1
  48. package/src/model/Ptsv2paymentsPointOfSaleInformation.js +9 -0
  49. package/src/model/Ptsv2paymentsProcessingInformation.js +18 -0
  50. package/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js +9 -0
  51. package/src/model/Ptsv2paymentsProcessingInformationJapanPaymentOptions.js +54 -0
  52. package/src/model/Ptsv2voidsProcessingInformation.js +82 -0
  53. package/src/model/TssV2TransactionsGet200ResponseClientReferenceInformationPartner.js +9 -0
  54. package/src/model/TssV2TransactionsGet200ResponsePaymentInformation.js +12 -4
  55. package/src/model/TssV2TransactionsGet200ResponsePaymentInformationCard.js +1 -1
  56. package/src/model/TssV2TransactionsGet200ResponsePaymentInformationFluidData.js +82 -0
  57. package/src/model/TssV2TransactionsGet200ResponsePointOfSaleInformation.js +9 -0
  58. package/src/model/TssV2TransactionsGet200ResponseProcessingInformation.js +9 -0
  59. package/src/model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.js +6 -6
  60. package/src/model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.js +82 -0
  61. package/src/model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.js +9 -0
  62. package/.idea/inspectionProfiles/Project_Default.xml +0 -6
  63. package/.idea/workspace.xml +0 -162
  64. package/cybersource-rest-client-0.0.38.tgz +0 -0
@@ -0,0 +1,9 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <module type="JAVA_MODULE" version="4">
3
+ <component name="NewModuleRootManager" inherit-compiler-output="true">
4
+ <exclude-output />
5
+ <content url="file://$MODULE_DIR$" />
6
+ <orderEntry type="inheritedJdk" />
7
+ <orderEntry type="sourceFolder" forTests="false" />
8
+ </component>
9
+ </module>
@@ -0,0 +1,6 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <project version="4">
3
+ <component name="JavaScriptLibraryMappings">
4
+ <file url="file://$PROJECT_DIR$" libraries="{Node.js Core}" />
5
+ </component>
6
+ </project>
@@ -0,0 +1,9 @@
1
+ <component name="libraryTable">
2
+ <library name="swagger-codegen-cli-2.3.0">
3
+ <CLASSES>
4
+ <root url="jar://$PROJECT_DIR$/generator/swagger-codegen-cli-2.3.0.jar!/" />
5
+ </CLASSES>
6
+ <JAVADOC />
7
+ <SOURCES />
8
+ </library>
9
+ </component>
package/.idea/misc.xml CHANGED
@@ -1,8 +1,6 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
2
  <project version="4">
3
- <component name="SwUserDefinedSpecifications">
4
- <option name="specTypeByUrl">
5
- <map />
6
- </option>
3
+ <component name="ProjectRootManager">
4
+ <output url="file://$PROJECT_DIR$/out" />
7
5
  </component>
8
6
  </project>
@@ -0,0 +1,8 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <project version="4">
3
+ <component name="ProjectModuleManager">
4
+ <modules>
5
+ <module fileurl="file://$PROJECT_DIR$/.idea/cybersource-rest-client-node.iml" filepath="$PROJECT_DIR$/.idea/cybersource-rest-client-node.iml" />
6
+ </modules>
7
+ </component>
8
+ </project>
@@ -4,18 +4,18 @@ All URIs are relative to *https://apitest.cybersource.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**createP12Keys**](AsymmetricKeyManagementApi.md#createP12Keys) | **POST** /kms/v2/keys-asym | Create one or more PKCS#12 keys
8
- [**deleteBulkP12Keys**](AsymmetricKeyManagementApi.md#deleteBulkP12Keys) | **POST** /kms/v2/keys-asym/deletes | Delete one or more PKCS#12 keys
9
- [**getP12KeyDetails**](AsymmetricKeyManagementApi.md#getP12KeyDetails) | **GET** /kms/v2/keys-asym/{keyId} | Retrieves PKCS#12 key details
7
+ [**createP12Keys**](AsymmetricKeyManagementApi.md#createP12Keys) | **POST** /kms/v2/keys-asym | Create one or more PKCS12 keys
8
+ [**deleteBulkP12Keys**](AsymmetricKeyManagementApi.md#deleteBulkP12Keys) | **POST** /kms/v2/keys-asym/deletes | Delete one or more PKCS12 keys
9
+ [**getP12KeyDetails**](AsymmetricKeyManagementApi.md#getP12KeyDetails) | **GET** /kms/v2/keys-asym/{keyId} | Retrieves PKCS12 key details
10
10
 
11
11
 
12
12
  <a name="createP12Keys"></a>
13
13
  # **createP12Keys**
14
14
  > KmsV2KeysAsymPost201Response createP12Keys(createP12KeysRequest)
15
15
 
16
- Create one or more PKCS#12 keys
16
+ Create one or more PKCS12 keys
17
17
 
18
- &#39;Create one or more PKCS#12 keys&#39;
18
+ &#39;Create one or more PKCS12 keys&#39;
19
19
 
20
20
  ### Example
21
21
  ```javascript
@@ -59,9 +59,9 @@ No authorization required
59
59
  # **deleteBulkP12Keys**
60
60
  > KmsV2KeysAsymDeletesPost200Response deleteBulkP12Keys(deleteBulkP12KeysRequest)
61
61
 
62
- Delete one or more PKCS#12 keys
62
+ Delete one or more PKCS12 keys
63
63
 
64
- &#39;Delete one or more PKCS#12 keys&#39;
64
+ &#39;Delete one or more PKCS12 keys&#39;
65
65
 
66
66
  ### Example
67
67
  ```javascript
@@ -105,7 +105,7 @@ No authorization required
105
105
  # **getP12KeyDetails**
106
106
  > KmsV2KeysAsymGet200Response getP12KeyDetails(keyId)
107
107
 
108
- Retrieves PKCS#12 key details
108
+ Retrieves PKCS12 key details
109
109
 
110
110
  Retrieves keys details by providing the key id.
111
111
 
@@ -5,7 +5,8 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **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]
7
7
  **status** | **String** | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional]
8
- **reason** | **String** | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA | [optional]
8
+ **reason** | **String** | The reason of the status. Possible values: - MISSING_FIELD | [optional]
9
9
  **message** | **String** | The detail message related to the status and reason listed above. | [optional]
10
+ **statusCode** | **String** | HTTP status code of the submitted request. Possible values: - 500 | [optional]
10
11
 
11
12
 
@@ -0,0 +1,12 @@
1
+ # CyberSource.InlineResponse502
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **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]
7
+ **status** | **String** | The status of the submitted transaction. Possible values: - SERVER_ERROR | [optional]
8
+ **reason** | **String** | The reason of the status. Possible values: - SYSTEM_ERROR - SERVER_TIMEOUT - SERVICE_TIMEOUT | [optional]
9
+ **message** | **String** | The detail message related to the status and reason listed above. | [optional]
10
+ **statusCode** | **String** | HTTP status code of the submitted request. Possible values: - 500 | [optional]
11
+
12
+
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **organizationId** | **String** | Merchant Id | [optional]
7
+ **externalOrganizationId** | **String** | Payworks MerchantId for given organizationId. | [optional]
7
8
  **referenceNumber** | **String** | Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response. | [optional]
8
9
  **keyId** | **String** | Key Serial Number | [optional]
9
10
  **key** | **String** | value of the key | [optional]
@@ -5,5 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **clientReferenceInformation** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional]
7
7
  **paymentInformation** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional]
8
+ **orderInformation** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional]
9
+ **processingInformation** | [**Ptsv2voidsProcessingInformation**](Ptsv2voidsProcessingInformation.md) | | [optional]
8
10
 
9
11
 
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
9
9
  **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]
10
10
  **responseCode** | **String** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is &#x60;08&#x60;, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: &#x60;aa,bb&#x60; with the two values separated by a comma and where: - &#x60;aa&#x60; is the two-digit error message from Atos. - &#x60;bb&#x60; is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example &#x60;2:R06&#x60; #### JCN Gateway Processor-defined detail error code. The associated response category code is in the &#x60;processorInformation.responseCategoryCode&#x60; field. String (3) | [optional]
11
11
  **achVerification** | [**PtsV2PaymentsPost201ResponseProcessorInformationAchVerification**](PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md) | | [optional]
12
+ **networkTransactionId** | **String** | Same value as &#x60;processorInformation.transactionId&#x60; | [optional]
12
13
 
13
14
 
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: &#x60;MM&#x60;. Valid values: &#x60;01&#x60; through &#x60;12&#x60;. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (&#x60;01&#x60; through &#x60;12&#x60;) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_&#x3D;039), if there is no expiration date on the card, use &#x60;12&#x60;. #### FDMS Nashville Required field. #### 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. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional]
8
8
  **expirationYear** | **String** | Four-digit year in which the payment card expires. Format: &#x60;YYYY&#x60;. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (&#x60;1900&#x60; through &#x60;3000&#x60;) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**&#x60;&#x3D;039&#x60;), if there is no expiration date on the card, use &#x60;2021&#x60;. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### 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. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional]
9
9
  **type** | **String** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - &#x60;001&#x60;: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value &#x60;001&#x60; for Visa Electron. - &#x60;002&#x60;: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - &#x60;003&#x60;: American Express - &#x60;004&#x60;: Discover - &#x60;005&#x60;: Diners Club - &#x60;006&#x60;: Carte Blanche[^1] - &#x60;007&#x60;: JCB[^1] - &#x60;014&#x60;: Enroute[^1] - &#x60;021&#x60;: JAL[^1] - &#x60;024&#x60;: Maestro (UK Domestic)[^1] - &#x60;031&#x60;: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use &#x60;001&#x60; for all Visa card types. - &#x60;033&#x60;: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use &#x60;001&#x60; for all Visa card types. - &#x60;034&#x60;: Dankort[^1] - &#x60;036&#x60;: Cartes Bancaires[^1,4] - &#x60;037&#x60;: Carta Si[^1] - &#x60;039&#x60;: Encoded account number[^1] - &#x60;040&#x60;: UATP[^1] - &#x60;042&#x60;: Maestro (International)[^1] - &#x60;050&#x60;: Hipercard[^2,3] - &#x60;051&#x60;: Aura - &#x60;054&#x60;: Elo[^3] - &#x60;062&#x60;: China UnionPay [^1]: For this card type, you must include the &#x60;paymentInformation.card.type&#x60; or &#x60;paymentInformation.tokenizedCard.type&#x60; field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the &#x60;paymentInformation.card.type&#x60; or &#x60;paymentInformation.tokenizedCard.type&#x60; field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the &#x60;paymentInformation.card.type&#x60; or &#x60;paymentInformation.tokenizedCard.type&#x60; field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the &#x60;paymentInformation.card.type&#x60; in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional]
10
- **useAs** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. #### Cielo and Comercio Latino Possible values: - CREDIT: Credit card - DEBIT: Debit card This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **Note** The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 51 - Field: Combination Card Transaction Identifier This field is supported only for Mastercard transactions in Brazil on CyberSource through VisaNet. | [optional]
10
+ **useAs** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. Possible values: - C: Credit transaction - D: Debit transaction This field is supported only for all card Types on Visa Platform Connect. This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **Note** The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 51 - Field: Combination Card Transaction Identifier | [optional]
11
11
  **sourceAccountType** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for CyberSource through VisaNet (CtV). **Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - &#x60;CHECKING&#x60;: Checking account - &#x60;CREDIT&#x60;: Credit card account - &#x60;SAVING&#x60;: Saving account - &#x60;LINE_OF_CREDIT&#x60;: Line of credit or credit portion of combo card - &#x60;PREPAID&#x60;: Prepaid card account or prepaid portion of combo card - &#x60;UNIVERSAL&#x60;: Universal account | [optional]
12
12
  **sourceAccountTypeDetails** | **String** | Type of account that is being used when the value for the override_payment_method field is line of credit (LI) or prepaid card (PP). Possible values for line of credit: - &#x60;AGRC&#x60;: Visa Agro Custeio - &#x60;AGRE&#x60;: Visa Agro Electron - &#x60;AGRI&#x60;: Visa Agro Investimento - &#x60;AGRO&#x60;: Visa Agro Possible values for prepaid card: - &#x60;VVA&#x60;: Visa Vale Alimentacao - &#x60;VVF&#x60;: Visa Vale Flex - &#x60;VVR&#x60;: Visa Vale Refeicao This field is supported only for combo card transactions in Brazil on CyberSource through VisaNet. | [optional]
13
13
  **securityCode** | **String** | Card Verification Number. #### FDMS Nashville Required for American Express or if swiped; otherwise, optional. #### Ingenico ePayments Do not include this field when &#x60;commerceIndicator&#x3D;recurring&#x60;. **Note** Ingenico ePayments was previously called _Global Collect_. #### TSYS Acquiring Solutions Optional if pointOfSaleInformation.entryMode&#x3D;keyed; otherwise, not used. #### GPX Optional. #### All other processors: Optional. | [optional]
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal | [optional]
6
+ **name** | **String** | A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data | [optional]
7
7
 
8
8
 
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **terminalId** | **String** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource through VisaNet A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. When you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by **Authorization** Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include &#x60;pointOfSaleInformation.catLevel&#x60;. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt. | [optional]
7
7
  **terminalSerialNumber** | **String** | Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. This value is not forwarded to the processor. Instead, the value is forwarded to the reporting functionality. #### Used by **Authorization and Credit** Optional. This field is supported only by client software that is installed on your POS terminals for the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX | [optional]
8
+ **cardholderVerificationMethodUsed** | **Number** | Method that was used to verify the cardholder&#39;s identity. Possible values: - &#x60;0&#x60;: No verification - &#x60;1&#x60;: Signature - &#x60;2&#x60;: PIN - &#x60;3&#x60;: Cardholder device CVM | [optional]
8
9
  **laneNumber** | **String** | Identifier for an alternate terminal at your retail location. You define the value for this field. This field is supported only for MasterCard transactions on FDC Nashville Global. Otherwise, this field is not used by all other processors. Use the &#x60;terminalId&#x60; field to identify the main terminal at your retail location. If your retail location has multiple terminals, use this &#x60;laneNumber&#x60; field to identify the terminal used for the transaction. This field is a pass-through, which means that the value is not checked or modified in any way before sending it to the processor. Optional field. #### Card present reply messaging Identifier for an alternate terminal at your retail location. You defined the value for this field in the request message. This value must be printed on the receipt. This field is supported only for MasterCard transactions on FDC Nashville Global. | [optional]
9
10
  **catLevel** | **Number** | Type of cardholder-activated terminal. Possible values: - 1: Automated dispensing machine - 2: Self-service terminal - 3: Limited amount terminal - 4: In-flight commerce (IFC) terminal - 5: Radio frequency device - 6: Mobile acceptance terminal - 7: Electronic cash register - 8: E-commerce device at your location - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network #### Chase Paymentech Solutions Only values 1, 2, and 3 are supported. Required if &#x60;pointOfSaleInformation.terminalID&#x60; is included in the request; otherwise, optional. #### CyberSource through VisaNet Values 1 through 6 are supported on CyberSource through VisaNet, but some acquirers do not support all six values. Optional field. #### FDC Nashville Global Only values 7, 8, and 9 are supported. Optional field for EMV transactions; otherwise, not used. #### GPN Only values 6, 7, 8, and 9 are supported. Required field. #### JCN Gateway Only values 6, 7, 8, and 9 are supported. Required field. #### TSYS Acquiring Solutions Only value 6 is supported. Required for transactions from mobile devices; otherwise, not used. #### All other processors Not used. Nonnegative integer. | [optional]
10
11
  **entryMode** | **String** | Method of entering payment card information into the POS terminal. Possible values: - &#x60;contact&#x60;: Read from direct contact with chip card. - &#x60;contactless&#x60;: Read from a contactless interface using chip data. - &#x60;keyed&#x60;: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. - &#x60;msd&#x60;: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. - &#x60;swiped&#x60;: Read from credit card magnetic stripe. The &#x60;contact&#x60;, &#x60;contactless&#x60;, and &#x60;msd&#x60; values are supported only for EMV transactions. #### Used by **Authorization** Required field. #### Card Present Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. #### PIN debit Required for a PIN debit purchase and a PIN debit credit request. | [optional]
@@ -9,10 +9,12 @@ Name | Type | Description | Notes
9
9
  **processorId** | **String** | Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. Contact CyberSource Customer Support to get the value for this field. | [optional]
10
10
  **businessApplicationId** | **String** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the &#x60;invoiceHeader_businessApplicationID&#x60; field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) | [optional]
11
11
  **commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \&quot;Commerce Indicators,\&quot; on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \&quot;Commerce Indicators,\&quot; on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \&quot;Payer Authentication,\&quot; page 195. #### Card Present You must set this field to &#x60;retail&#x60;. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as “moto\&quot; | [optional]
12
+ **commerceIndicatorLabel** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \&quot;Commerce Indicators,\&quot; on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \&quot;Commerce Indicators,\&quot; on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \&quot;Payer Authentication,\&quot; page 195. #### Card Present You must set this field to &#x60;retail&#x60;. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as “moto\&quot; | [optional]
12
13
  **paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - &#x60;visacheckout&#x60;: Visa Checkout. This value is required for Visa Checkout transactions. For details, see &#x60;payment_solution&#x60; field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - &#x60;001&#x60;: Apple Pay. - &#x60;004&#x60;: Cybersource In-App Solution. - &#x60;005&#x60;: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \&quot;Masterpass\&quot; in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - &#x60;006&#x60;: Android Pay. - &#x60;007&#x60;: Chase Pay. - &#x60;008&#x60;: Samsung Pay. - &#x60;012&#x60;: Google Pay. - &#x60;013&#x60;: Cybersource P2PE Decryption - &#x60;014&#x60;: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - &#x60;015&#x60;: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - &#x60;027&#x60;: Click to Pay. | [optional]
13
14
  **reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional]
14
15
  **linkId** | **String** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see &#x60;link_to_request&#x60; field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
15
16
  **purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional]
17
+ **paymentId** | **String** | This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream. | [optional]
16
18
  **reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see &#x60;report_group&#x60; field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
17
19
  **visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional]
18
20
  **industryDataType** | **String** | Indicates that the transaction includes industry-specific data. Possible Values: - &#x60;airline&#x60; - &#x60;restaurant&#x60; - &#x60;lodging&#x60; - &#x60;auto_rental&#x60; - &#x60;transit&#x60; - &#x60;healthcare_medical&#x60; - &#x60;healthcare_transit&#x60; - &#x60;transit&#x60; #### Card Present, Airlines and Auto Rental You must set this field to &#x60;airline&#x60; in order for airline data to be sent to the processor. For example, if this field is not set to &#x60;airline&#x60; or is not included in the request, no airline data is sent to the processor. You must set this field to &#x60;restaurant&#x60; in order for restaurant data to be sent to the processor. When this field is not set to &#x60;restaurant&#x60; or is not included in the request, no restaurant data is sent to the processor. You must set this field to &#x60;auto_rental&#x60; in order for auto rental data to be sent to the processor. For example, if this field is not set to &#x60;auto_rental&#x60; or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet. | [optional]
@@ -21,5 +21,6 @@ Name | Type | Description | Notes
21
21
  **aggregatedAuthIndicator** | **String** | Indicates if transaction is an aggregated auth Possible values: - **true** - **false** | [optional]
22
22
  **debtRecoveryIndicator** | **String** | Indicates if transaction is a debt recovery request Possible values: - **true** - **false** | [optional]
23
23
  **deferredAuthIndicator** | **Boolean** | Flag that indicates whether the authorization request was delayed because connectivity was interrupted. Possible values: - &#x60;true&#x60; (Deferred authorization) - &#x60;false&#x60; (default: Not a deferred authorization) | [optional]
24
+ **cashAdvanceIndicator** | **Boolean** | This API field enables the merchant to indicate that a given transaction is Cash Advance. Cash advance or Cash disbursement functionality allows a merchant to dispense cash at a point of sale. It provides the ability of a POS system to act like an ATM. These terminals are typically seen in bank branches where customers can use their card and withdraw cash or at merchant locations where ATMs are sparse. Possible values: - &#x60;true&#x60; (Cash advance is supported) - &#x60;false&#x60; (default: cash advance is not supported) | [optional]
24
25
 
25
26
 
@@ -4,6 +4,12 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **paymentMethod** | **String** | This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the tranasction. - 10 (One-time payment) - 21, 22, 23, 24 (Bonus(one-time)payment) - 61 (Installment payment) - 31, 32, 33, 34 (Integrated (Bonus + Installment)payment) - 80 (Revolving payment) | [optional]
7
+ **bonuses** | **String** | This value is a 2-digit code indicating the Number of Bonuses. Valid value from 1 to 6. | [optional]
8
+ **bonusMonth** | **String** | This value is a 2-digit code indicating the first bonus month. Valid value from 1 to 12. | [optional]
9
+ **secondBonusMonth** | **String** | This value is a 2-digit code indicating the second bonus month. Valid value from 1 to 12. | [optional]
10
+ **bonusAmount** | **String** | This value contains the bonus amount of the first month. Maximum value without decimal 99999999. | [optional]
11
+ **secondBonusAmount** | **String** | This value contains the bonus amount of the second month. Maximum value without decimal 99999999. | [optional]
12
+ **preapprovalType** | **String** | This will contain the details of the kind of transaction that has been processe. Used only for Japan. Possible Values: - 0 &#x3D; Normal (authorization with amount and clearing/settlement; data capture or paper draft) - 1 &#x3D; Negative card authorization (authorization-only with 0 or 1 amount) - 2 &#x3D; Reservation of authorization (authorization-only with amount) - 3 &#x3D; Cancel transaction - 4 &#x3D; Merchant-initiated reversal/refund transactions - 5 &#x3D; Cancel reservation of authorization - 6 &#x3D; Post authorization | [optional]
7
13
  **installments** | **String** | Number of Installments. | [optional]
8
14
  **terminalId** | **String** | Unique Japan Credit Card Association (JCCA) terminal identifier. The difference between this field and the &#x60;pointOfSaleInformation.terminalID&#x60; field is that you can define &#x60;pointOfSaleInformation.terminalID&#x60;, but &#x60;processingInformation.japanPaymentOptions.terminalId&#x60; is defined by the JCCA and is used only in Japan. This field is supported only on CyberSource through VisaNet and JCN Gateway. Optional field. | [optional]
9
15
  **firstBillingMonth** | **String** | Billing month in MM format. | [optional]
@@ -0,0 +1,8 @@
1
+ # CyberSource.Ptsv2voidsProcessingInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **paymentId** | **String** | This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream. | [optional]
7
+
8
+
@@ -1,115 +1,115 @@
1
- # CyberSource.SecureFileShareApi
2
-
3
- All URIs are relative to *https://apitest.cybersource.com*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**getFile**](SecureFileShareApi.md#getFile) | **GET** /sfs/v1/files/{fileId} | Download a File with File Identifier
8
- [**getFileDetail**](SecureFileShareApi.md#getFileDetail) | **GET** /sfs/v1/file-details | Get List of Files
9
-
10
-
11
- <a name="getFile"></a>
12
- # **getFile**
13
- > getFile(fileId, opts)
14
-
15
- Download a File with File Identifier
16
-
17
- Download a file for the given file identifier
18
-
19
- ### Example
20
- ```javascript
21
- var CyberSource = require('CyberSource');
22
-
23
- var apiInstance = new CyberSource.SecureFileShareApi();
24
-
25
- var fileId = "fileId_example"; // String | Unique identifier for each file
26
-
27
- var opts = {
28
- 'organizationId': "organizationId_example" // String | Valid Cybersource Organization Id
29
- };
30
-
31
- var callback = function(error, data, response) {
32
- if (error) {
33
- console.error(error);
34
- } else {
35
- console.log('API called successfully.');
36
- }
37
- };
38
- apiInstance.getFile(fileId, opts, callback);
39
- ```
40
-
41
- ### Parameters
42
-
43
- Name | Type | Description | Notes
44
- ------------- | ------------- | ------------- | -------------
45
- **fileId** | **String**| Unique identifier for each file |
46
- **organizationId** | **String**| Valid Cybersource Organization Id | [optional]
47
-
48
- ### Return type
49
-
50
- null (empty response body)
51
-
52
- ### Authorization
53
-
54
- No authorization required
55
-
56
- ### HTTP request headers
57
-
58
- - **Content-Type**: */*;charset=utf-8
59
- - **Accept**: application/xml, text/csv, application/pdf
60
-
61
- <a name="getFileDetail"></a>
62
- # **getFileDetail**
63
- > V1FileDetailsGet200Response getFileDetail(startDate, endDate, opts)
64
-
65
- Get List of Files
66
-
67
- Get list of files and it&#39;s information of them available inside the report directory
68
-
69
- ### Example
70
- ```javascript
71
- var CyberSource = require('CyberSource');
72
-
73
- var apiInstance = new CyberSource.SecureFileShareApi();
74
-
75
- var startDate = new Date("2013-10-20"); // Date | Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd
76
-
77
- var endDate = new Date("2013-10-20"); // Date | Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd
78
-
79
- var opts = {
80
- 'organizationId': "organizationId_example", // String | Valid Cybersource Organization Id
81
- 'name': "name_example" // String | **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml
82
- };
83
-
84
- var callback = function(error, data, response) {
85
- if (error) {
86
- console.error(error);
87
- } else {
88
- console.log('API called successfully. Returned data: ' + data);
89
- }
90
- };
91
- apiInstance.getFileDetail(startDate, endDate, opts, callback);
92
- ```
93
-
94
- ### Parameters
95
-
96
- Name | Type | Description | Notes
97
- ------------- | ------------- | ------------- | -------------
98
- **startDate** | **Date**| Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd |
99
- **endDate** | **Date**| Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd |
100
- **organizationId** | **String**| Valid Cybersource Organization Id | [optional]
101
- **name** | **String**| **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml | [optional]
102
-
103
- ### Return type
104
-
105
- [**V1FileDetailsGet200Response**](V1FileDetailsGet200Response.md)
106
-
107
- ### Authorization
108
-
109
- No authorization required
110
-
111
- ### HTTP request headers
112
-
113
- - **Content-Type**: */*;charset=utf-8
114
- - **Accept**: application/hal+json
115
-
1
+ # CyberSource.SecureFileShareApi
2
+
3
+ All URIs are relative to *https://apitest.cybersource.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**getFile**](SecureFileShareApi.md#getFile) | **GET** /sfs/v1/files/{fileId} | Download a File with File Identifier
8
+ [**getFileDetail**](SecureFileShareApi.md#getFileDetail) | **GET** /sfs/v1/file-details | Get List of Files
9
+
10
+
11
+ <a name="getFile"></a>
12
+ # **getFile**
13
+ > getFile(fileId, opts)
14
+
15
+ Download a File with File Identifier
16
+
17
+ Download a file for the given file identifier
18
+
19
+ ### Example
20
+ ```javascript
21
+ var CyberSource = require('CyberSource');
22
+
23
+ var apiInstance = new CyberSource.SecureFileShareApi();
24
+
25
+ var fileId = "fileId_example"; // String | Unique identifier for each file
26
+
27
+ var opts = {
28
+ 'organizationId': "organizationId_example" // String | Valid Cybersource Organization Id
29
+ };
30
+
31
+ var callback = function(error, data, response) {
32
+ if (error) {
33
+ console.error(error);
34
+ } else {
35
+ console.log('API called successfully.');
36
+ }
37
+ };
38
+ apiInstance.getFile(fileId, opts, callback);
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ Name | Type | Description | Notes
44
+ ------------- | ------------- | ------------- | -------------
45
+ **fileId** | **String**| Unique identifier for each file |
46
+ **organizationId** | **String**| Valid Cybersource Organization Id | [optional]
47
+
48
+ ### Return type
49
+
50
+ null (empty response body)
51
+
52
+ ### Authorization
53
+
54
+ No authorization required
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: */*;charset=utf-8
59
+ - **Accept**: application/xml, text/csv, application/pdf
60
+
61
+ <a name="getFileDetail"></a>
62
+ # **getFileDetail**
63
+ > V1FileDetailsGet200Response getFileDetail(startDate, endDate, opts)
64
+
65
+ Get List of Files
66
+
67
+ Get list of files and it&#39;s information of them available inside the report directory
68
+
69
+ ### Example
70
+ ```javascript
71
+ var CyberSource = require('CyberSource');
72
+
73
+ var apiInstance = new CyberSource.SecureFileShareApi();
74
+
75
+ var startDate = new Date("2013-10-20"); // Date | Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd
76
+
77
+ var endDate = new Date("2013-10-20"); // Date | Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd
78
+
79
+ var opts = {
80
+ 'organizationId': "organizationId_example", // String | Valid Cybersource Organization Id
81
+ 'name': "name_example" // String | **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml
82
+ };
83
+
84
+ var callback = function(error, data, response) {
85
+ if (error) {
86
+ console.error(error);
87
+ } else {
88
+ console.log('API called successfully. Returned data: ' + data);
89
+ }
90
+ };
91
+ apiInstance.getFileDetail(startDate, endDate, opts, callback);
92
+ ```
93
+
94
+ ### Parameters
95
+
96
+ Name | Type | Description | Notes
97
+ ------------- | ------------- | ------------- | -------------
98
+ **startDate** | **Date**| Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd |
99
+ **endDate** | **Date**| Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd |
100
+ **organizationId** | **String**| Valid Cybersource Organization Id | [optional]
101
+ **name** | **String**| **Tailored to searches for specific files with in given Date range** example : MyTransactionDetailreport.xml | [optional]
102
+
103
+ ### Return type
104
+
105
+ [**V1FileDetailsGet200Response**](V1FileDetailsGet200Response.md)
106
+
107
+ ### Authorization
108
+
109
+ No authorization required
110
+
111
+ ### HTTP request headers
112
+
113
+ - **Content-Type**: */*;charset=utf-8
114
+ - **Accept**: application/hal+json
115
+
@@ -4,5 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **solutionId** | **String** | Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect. | [optional]
7
+ **thirdPartyCertificationNumber** | **String** | Value that identifies the application vendor and application version for a third party gateway. CyberSource provides you with this value during testing and validation. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization, Authorization Reversal, Capture, Credit, Incremental Authorization, and Void** Optional field. #### PIN debit Required field for PIN debit credit, PIN debit purchase, or PIN debit reversal request. | [optional]
7
8
 
8
9
 
@@ -12,5 +12,6 @@ Name | Type | Description | Notes
12
12
  **paymentInstrument** | [**PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument**](PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument.md) | | [optional]
13
13
  **instrumentIdentifier** | [**TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier**](TssV2TransactionsGet200ResponsePaymentInformationInstrumentIdentifier.md) | | [optional]
14
14
  **shippingAddress** | [**PtsV2PaymentsPost201ResponseTokenInformationShippingAddress**](PtsV2PaymentsPost201ResponseTokenInformationShippingAddress.md) | | [optional]
15
+ **fluidData** | [**TssV2TransactionsGet200ResponsePaymentInformationFluidData**](TssV2TransactionsGet200ResponsePaymentInformationFluidData.md) | | [optional]
15
16
 
16
17
 
@@ -12,6 +12,6 @@ Name | Type | Description | Notes
12
12
  **issueNumber** | **String** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. | [optional]
13
13
  **type** | **String** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - &#x60;001&#x60;: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value &#x60;001&#x60; for Visa Electron. - &#x60;002&#x60;: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - &#x60;003&#x60;: American Express - &#x60;004&#x60;: Discover - &#x60;005&#x60;: Diners Club - &#x60;006&#x60;: Carte Blanche[^1] - &#x60;007&#x60;: JCB[^1] - &#x60;014&#x60;: Enroute[^1] - &#x60;021&#x60;: JAL[^1] - &#x60;024&#x60;: Maestro (UK Domestic)[^1] - &#x60;031&#x60;: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use &#x60;001&#x60; for all Visa card types. - &#x60;033&#x60;: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use &#x60;001&#x60; for all Visa card types. - &#x60;034&#x60;: Dankort[^1] - &#x60;036&#x60;: Cartes Bancaires[^1,4] - &#x60;037&#x60;: Carta Si[^1] - &#x60;039&#x60;: Encoded account number[^1] - &#x60;040&#x60;: UATP[^1] - &#x60;042&#x60;: Maestro (International)[^1] - &#x60;050&#x60;: Hipercard[^2,3] - &#x60;051&#x60;: Aura - &#x60;054&#x60;: Elo[^3] - &#x60;062&#x60;: China UnionPay [^1]: For this card type, you must include the &#x60;paymentInformation.card.type&#x60; or &#x60;paymentInformation.tokenizedCard.type&#x60; field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the &#x60;paymentInformation.card.type&#x60; or &#x60;paymentInformation.tokenizedCard.type&#x60; field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the &#x60;paymentInformation.card.type&#x60; or &#x60;paymentInformation.tokenizedCard.type&#x60; field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the &#x60;paymentInformation.card.type&#x60; in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional]
14
14
  **accountEncoderId** | **String** | Identifier for the issuing bank that provided the customer’s encoded account number. Contact your processor for the bank’s ID. | [optional]
15
- **useAs** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. #### Cielo and Comercio Latino Possible values: - CREDIT: Credit card - DEBIT: Debit card This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **Note** The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 51 - Field: Combination Card Transaction Identifier This field is supported only for Mastercard transactions in Brazil on CyberSource through VisaNet. | [optional]
15
+ **useAs** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. Possible values: - C: Credit transaction - D: Debit transaction This field is supported only for all card Types on Visa Platform Connect. This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **Note** The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 51 - Field: Combination Card Transaction Identifier | [optional]
16
16
 
17
17
 
@@ -0,0 +1,8 @@
1
+ # CyberSource.TssV2TransactionsGet200ResponsePaymentInformationFluidData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **descriptor** | **String** | The identifier for a payment solution, which is sending the encrypted payment data for decryption. Valid values: Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ&#x3D; Note: For other payment solutions, the value may be specific to the terminal or device initiatinf the payment. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits. Card Present processing: Format of the encrypted payment data. The value for Bluefin PCI P2PE is &#x60;Ymx1ZWZpbg&#x3D;&#x3D;&#x60;. paymentInformation.fluidData.encoding must be &#x60;Base64&#x60;. The value for Cybersource P2PE decryption depends on the encoding method used and identified in encoding field. If paymentInformation.fluidData.encoding is &#x60;Base64&#x60;, the value is: &#x60;RklEPUVNVi5QQVlNRU5ULkFQSQ&#x3D;&#x3D;&#x60; If paymentInformation.fluidData.encoding is &#x60;HEX&#x60;, the value is: &#x60;4649443D454D562E5041594D454E542E41504&#x60; | [optional]
7
+
8
+
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  **terminalId** | **String** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource through VisaNet A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. When you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by **Authorization** Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include &#x60;pointOfSaleInformation.catLevel&#x60;. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt. | [optional]
7
7
  **entryMode** | **String** | Method of entering payment card information into the POS terminal. Possible values: - &#x60;contact&#x60;: Read from direct contact with chip card. - &#x60;contactless&#x60;: Read from a contactless interface using chip data. - &#x60;keyed&#x60;: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. - &#x60;msd&#x60;: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. - &#x60;swiped&#x60;: Read from credit card magnetic stripe. The &#x60;contact&#x60;, &#x60;contactless&#x60;, and &#x60;msd&#x60; values are supported only for EMV transactions. #### Used by **Authorization** Required field. #### Card Present Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. #### PIN debit Required for a PIN debit purchase and a PIN debit credit request. | [optional]
8
8
  **terminalCapability** | **Number** | POS terminal’s capability. Possible values: - &#x60;1&#x60;: Terminal has a magnetic stripe reader only. - &#x60;2&#x60;: Terminal has a magnetic stripe reader and manual entry capability. - &#x60;3&#x60;: Terminal has manual entry capability only. - &#x60;4&#x60;: Terminal can read chip cards. - &#x60;5&#x60;: Terminal can read contactless chip cards; cannot use contact to read chip cards. For an EMV transaction, the value of this field must be &#x60;4&#x60; or &#x60;5&#x60;. #### PIN debit Required for PIN debit purchase and PIN debit credit request. #### Used by **Authorization** Required for the following processors: - American Express Direct - Chase Paymentech Solutions - Credit Mutuel-CIC - FDC Nashville Global - FDMS Nashville - OmniPay Direct - SIX - Worldpay VAP Optional for the following processors: - CyberSource through VisaNet - GPN - GPX - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions | [optional]
9
+ **cardholderVerificationMethodUsed** | **Number** | Method that was used to verify the cardholder&#39;s identity. Possible values: - &#x60;0&#x60;: No verification - &#x60;1&#x60;: Signature - &#x60;2&#x60;: PIN - &#x60;3&#x60;: Cardholder device CVM | [optional]
9
10
  **emv** | [**Ptsv2paymentsidreversalsPointOfSaleInformationEmv**](Ptsv2paymentsidreversalsPointOfSaleInformationEmv.md) | | [optional]
10
11
 
11
12
 
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  **industryDataType** | **String** | Indicates that the transaction includes industry-specific data. Possible Values: - &#x60;airline&#x60; - &#x60;restaurant&#x60; - &#x60;lodging&#x60; - &#x60;auto_rental&#x60; - &#x60;transit&#x60; - &#x60;healthcare_medical&#x60; - &#x60;healthcare_transit&#x60; - &#x60;transit&#x60; #### Card Present, Airlines and Auto Rental You must set this field to &#x60;airline&#x60; in order for airline data to be sent to the processor. For example, if this field is not set to &#x60;airline&#x60; or is not included in the request, no airline data is sent to the processor. You must set this field to &#x60;restaurant&#x60; in order for restaurant data to be sent to the processor. When this field is not set to &#x60;restaurant&#x60; or is not included in the request, no restaurant data is sent to the processor. You must set this field to &#x60;auto_rental&#x60; in order for auto rental data to be sent to the processor. For example, if this field is not set to &#x60;auto_rental&#x60; or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet. | [optional]
7
7
  **paymentSolution** | **String** | Type of digital payment solution for the transaction. | [optional]
8
8
  **commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \&quot;Commerce Indicators,\&quot; on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \&quot;Commerce Indicators,\&quot; on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \&quot;Payer Authentication,\&quot; page 195. #### Card Present You must set this field to &#x60;retail&#x60;. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as “moto\&quot; | [optional]
9
+ **commerceIndicatorLabel** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. See Appendix I, \&quot;Commerce Indicators,\&quot; on page 441 of the Cybersource Credit Card Guide. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value (listed in Appendix I, \&quot;Commerce Indicators,\&quot; on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see \&quot;Payer Authentication,\&quot; page 195. #### Card Present You must set this field to &#x60;retail&#x60;. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as “moto\&quot; | [optional]
9
10
  **businessApplicationId** | **String** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the &#x60;invoiceHeader_businessApplicationID&#x60; field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) | [optional]
10
11
  **authorizationOptions** | [**TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions**](TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md) | | [optional]
11
12
  **bankTransferOptions** | [**TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions**](TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.md) | | [optional]
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
6
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]
7
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
8
  **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]
9
- **partner** | [**TssV2TransactionsGet200ResponseClientReferenceInformationPartner**](TssV2TransactionsGet200ResponseClientReferenceInformationPartner.md) | | [optional]
9
+ **partner** | [**TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner**](TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformationPartner.md) | | [optional]
10
10
 
11
11