cybersource-rest-client 0.0.37 → 0.0.38
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.
- package/.idea/workspace.xml +119 -0
- package/docs/PtsV2PaymentsPost201ResponsePaymentAccountInformationCard.md +1 -0
- package/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md +1 -0
- package/docs/Ptsv2paymentsMerchantInformationMerchantDescriptor.md +1 -0
- package/docs/Ptsv2paymentsOrderInformation.md +1 -0
- package/docs/Ptsv2paymentsOrderInformationInvoiceDetails.md +1 -0
- package/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md +1 -1
- package/docs/Ptsv2paymentsPointOfSaleInformation.md +1 -0
- package/docs/Ptsv2paymentsPointOfSaleInformationEmv.md +3 -2
- package/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md +1 -0
- package/docs/Ptsv2paymentsProcessorInformation.md +1 -0
- package/docs/Ptsv2paymentsProcessorInformationAuthorizationOptions.md +8 -0
- package/docs/Ptsv2paymentsidcapturesPointOfSaleInformationEmv.md +1 -1
- package/docs/Ptsv2paymentsidvoidsOrderInformation.md +8 -0
- package/docs/Ptsv2payoutsOrderInformation.md +1 -0
- package/docs/Ptsv2payoutsProcessingInformation.md +1 -0
- package/docs/Ptsv2payoutsProcessingInformationFundingOptions.md +8 -0
- package/docs/Ptsv2payoutsProcessingInformationFundingOptionsInitiator.md +8 -0
- package/docs/Ptsv2payoutsSenderInformation.md +3 -0
- package/docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md +1 -1
- package/docs/Riskv1authenticationsPaymentInformationTokenizedCard.md +1 -1
- package/docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md +1 -1
- package/docs/Riskv1decisionsPaymentInformationTokenizedCard.md +1 -1
- package/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md +1 -1
- package/docs/VoidCaptureRequest.md +1 -0
- package/docs/VoidCreditRequest.md +1 -0
- package/docs/VoidPaymentRequest.md +1 -0
- package/docs/VoidRefundRequest.md +1 -0
- package/package.json +5 -4
- package/src/api/AsymmetricKeyManagementApi.js +3 -0
- package/src/api/ChargebackDetailsApi.js +3 -0
- package/src/api/ChargebackSummariesApi.js +3 -0
- package/src/api/ConversionDetailsApi.js +3 -0
- package/src/api/CustomerApi.js +6 -0
- package/src/api/CustomerPaymentInstrumentApi.js +9 -0
- package/src/api/CustomerShippingAddressApi.js +9 -0
- package/src/api/DownloadDTDApi.js +3 -0
- package/src/api/DownloadXSDApi.js +3 -0
- package/src/api/InstrumentIdentifierApi.js +9 -0
- package/src/api/InterchangeClearingLevelDetailsApi.js +3 -0
- package/src/api/InvoiceSettingsApi.js +3 -0
- package/src/api/InvoicesApi.js +12 -0
- package/src/api/NetFundingsApi.js +3 -0
- package/src/api/NotificationOfChangesApi.js +3 -0
- package/src/api/PaymentBatchSummariesApi.js +3 -0
- package/src/api/PaymentInstrumentApi.js +6 -0
- package/src/api/PurchaseAndRefundDetailsApi.js +3 -0
- package/src/api/ReportDefinitionsApi.js +6 -0
- package/src/api/ReportDownloadsApi.js +3 -0
- package/src/api/ReportSubscriptionsApi.js +9 -0
- package/src/api/ReportsApi.js +6 -0
- package/src/api/RetrievalDetailsApi.js +3 -0
- package/src/api/RetrievalSummariesApi.js +3 -0
- package/src/api/SearchTransactionsApi.js +3 -0
- package/src/api/SecureFileShareApi.js +6 -0
- package/src/api/SymmetricKeyManagementApi.js +3 -0
- package/src/api/TransactionBatchesApi.js +9 -0
- package/src/api/TransactionDetailsApi.js +3 -0
- package/src/api/UserManagementApi.js +3 -0
- package/src/authentication/logging/SensitiveDataTags.js +2 -0
- package/src/index.js +23 -3
- package/src/model/PtsV2PaymentsPost201ResponsePaymentAccountInformationCard.js +9 -0
- package/src/model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.js +9 -0
- package/src/model/Ptsv2paymentsMerchantInformationMerchantDescriptor.js +9 -0
- package/src/model/Ptsv2paymentsOrderInformation.js +9 -0
- package/src/model/Ptsv2paymentsOrderInformationInvoiceDetails.js +9 -0
- package/src/model/Ptsv2paymentsPaymentInformationTokenizedCard.js +1 -1
- package/src/model/Ptsv2paymentsPointOfSaleInformation.js +9 -0
- package/src/model/Ptsv2paymentsPointOfSaleInformationEmv.js +11 -3
- package/src/model/Ptsv2paymentsProcessingInformationAuthorizationOptions.js +9 -0
- package/src/model/Ptsv2paymentsProcessorInformation.js +12 -4
- package/src/model/Ptsv2paymentsProcessorInformationAuthorizationOptions.js +82 -0
- package/src/model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv.js +1 -2
- package/src/model/Ptsv2paymentsidvoidsOrderInformation.js +81 -0
- package/src/model/Ptsv2payoutsOrderInformation.js +9 -0
- package/src/model/Ptsv2payoutsProcessingInformation.js +12 -4
- package/src/model/Ptsv2payoutsProcessingInformationFundingOptions.js +81 -0
- package/src/model/Ptsv2payoutsProcessingInformationFundingOptionsInitiator.js +82 -0
- package/src/model/Ptsv2payoutsSenderInformation.js +27 -0
- package/src/model/Riskv1authenticationresultsPaymentInformationTokenizedCard.js +1 -1
- package/src/model/Riskv1authenticationsPaymentInformationTokenizedCard.js +1 -1
- package/src/model/Riskv1authenticationsetupsPaymentInformationTokenizedCard.js +2 -2
- package/src/model/Riskv1decisionsPaymentInformationTokenizedCard.js +1 -1
- package/src/model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.js +6 -6
- package/src/model/VoidCaptureRequest.js +12 -4
- package/src/model/VoidCreditRequest.js +12 -4
- package/src/model/VoidPaymentRequest.js +12 -4
- package/src/model/VoidRefundRequest.js +12 -4
- package/.idea/cybersource-rest-client-node.iml +0 -9
- package/.idea/libraries/sonar_scanner_cli_3_1_0_1141.xml +0 -9
- package/.idea/libraries/swagger_codegen_cli_2_3_0.xml +0 -9
- package/.idea/misc.xml +0 -6
- package/.idea/modules.xml +0 -8
- package/.idea/vcs.xml +0 -6
- package/cybersource-rest-client-0.0.36.tgz +0 -0
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<project version="4">
|
|
3
|
+
<component name="ChangeListManager">
|
|
4
|
+
<list default="true" id="69db6054-f163-40a2-925e-c9ec35e3cc46" name="Changes" comment="">
|
|
5
|
+
<change beforePath="$PROJECT_DIR$/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/package.json" afterDir="false" />
|
|
6
|
+
</list>
|
|
7
|
+
<option name="SHOW_DIALOG" value="false" />
|
|
8
|
+
<option name="HIGHLIGHT_CONFLICTS" value="true" />
|
|
9
|
+
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
|
|
10
|
+
<option name="LAST_RESOLUTION" value="IGNORE" />
|
|
11
|
+
</component>
|
|
12
|
+
<component name="Git.Merge.Settings">
|
|
13
|
+
<option name="BRANCH" value="origin/test-fix-empty-body-param" />
|
|
14
|
+
</component>
|
|
15
|
+
<component name="Git.Settings">
|
|
16
|
+
<option name="RECENT_BRANCH_BY_REPOSITORY">
|
|
17
|
+
<map>
|
|
18
|
+
<entry key="$PROJECT_DIR$" value="master" />
|
|
19
|
+
</map>
|
|
20
|
+
</option>
|
|
21
|
+
<option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
|
|
22
|
+
</component>
|
|
23
|
+
<component name="HighlightingSettingsPerFile">
|
|
24
|
+
<setting file="file://$PROJECT_DIR$/generator/cybersource-javascript-template/api.mustache" root0="FORCE_HIGHLIGHTING" />
|
|
25
|
+
<setting file="file://$PROJECT_DIR$/generator/cybersource-rest-spec.json" root0="FORCE_HIGHLIGHTING" />
|
|
26
|
+
<setting file="file://$PROJECT_DIR$/src/authentication/logging/Logger.js" root0="FORCE_HIGHLIGHTING" />
|
|
27
|
+
<setting file="file://$PROJECT_DIR$/src/authentication/logging/SensitiveDataMasker.js" root0="FORCE_HIGHLIGHTING" />
|
|
28
|
+
<setting file="file://$PROJECT_DIR$/src/authentication/logging/SensitiveDataTags.js" root0="FORCE_HIGHLIGHTING" />
|
|
29
|
+
<setting file="file://$PROJECT_DIR$/src/model/InvoicingV2InvoicesAllGet200Response.js" root0="SKIP_INSPECTION" />
|
|
30
|
+
<setting file="file://$PROJECT_DIR$/src/model/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.js" root0="FORCE_HIGHLIGHTING" />
|
|
31
|
+
<setting file="file://$PROJECT_DIR$/src/model/InvoicingV2InvoicesAllGet200ResponseInvoiceInformation.js" root0="FORCE_HIGHLIGHTING" />
|
|
32
|
+
<setting file="file://$PROJECT_DIR$/src/model/InvoicingV2InvoicesAllGet200ResponseInvoices.js" root0="FORCE_HIGHLIGHTING" />
|
|
33
|
+
<setting file="file://$PROJECT_DIR$/src/model/InvoicingV2InvoicesAllGet200ResponseLinks1.js" root0="FORCE_HIGHLIGHTING" />
|
|
34
|
+
<setting file="file://$PROJECT_DIR$/src/model/Invoicingv2invoicesCustomerInformation.js" root0="FORCE_HIGHLIGHTING" />
|
|
35
|
+
</component>
|
|
36
|
+
<component name="MarkdownSettingsMigration">
|
|
37
|
+
<option name="stateVersion" value="1" />
|
|
38
|
+
</component>
|
|
39
|
+
<component name="ProjectId" id="290NDlE5hOY72I4zJERUzhWJ87M" />
|
|
40
|
+
<component name="ProjectViewState">
|
|
41
|
+
<option name="hideEmptyMiddlePackages" value="true" />
|
|
42
|
+
<option name="showLibraryContents" value="true" />
|
|
43
|
+
</component>
|
|
44
|
+
<component name="PropertiesComponent">{
|
|
45
|
+
"keyToString": {
|
|
46
|
+
"RunOnceActivity.OpenProjectViewOnStart": "true",
|
|
47
|
+
"RunOnceActivity.ShowReadmeOnStart": "true",
|
|
48
|
+
"WebServerToolWindowFactoryState": "false",
|
|
49
|
+
"last_opened_file_path": "/Users/rsachan/Desktop/Mavericks/rest-sdk/cybersource-rest-client-node",
|
|
50
|
+
"nodejs_package_manager_path": "npm"
|
|
51
|
+
}
|
|
52
|
+
}</component>
|
|
53
|
+
<component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
|
|
54
|
+
<component name="TaskManager">
|
|
55
|
+
<task active="true" id="Default" summary="Default task">
|
|
56
|
+
<changelist id="69db6054-f163-40a2-925e-c9ec35e3cc46" name="Changes" comment="" />
|
|
57
|
+
<created>1652245926043</created>
|
|
58
|
+
<option name="number" value="Default" />
|
|
59
|
+
<option name="presentableId" value="Default" />
|
|
60
|
+
<updated>1652245926043</updated>
|
|
61
|
+
<workItem from="1652245929317" duration="11829000" />
|
|
62
|
+
<workItem from="1652678985213" duration="5024000" />
|
|
63
|
+
<workItem from="1653109252715" duration="801000" />
|
|
64
|
+
</task>
|
|
65
|
+
<servers />
|
|
66
|
+
</component>
|
|
67
|
+
<component name="TypeScriptGeneratedFilesManager">
|
|
68
|
+
<option name="version" value="3" />
|
|
69
|
+
</component>
|
|
70
|
+
<component name="Vcs.Log.History.Properties">
|
|
71
|
+
<option name="COLUMN_ID_ORDER">
|
|
72
|
+
<list>
|
|
73
|
+
<option value="Default.Root" />
|
|
74
|
+
<option value="Default.Author" />
|
|
75
|
+
<option value="Default.Date" />
|
|
76
|
+
<option value="Space.CommitStatus" />
|
|
77
|
+
<option value="Default.Subject" />
|
|
78
|
+
</list>
|
|
79
|
+
</option>
|
|
80
|
+
</component>
|
|
81
|
+
<component name="Vcs.Log.Tabs.Properties">
|
|
82
|
+
<option name="TAB_STATES">
|
|
83
|
+
<map>
|
|
84
|
+
<entry key="MAIN">
|
|
85
|
+
<value>
|
|
86
|
+
<State>
|
|
87
|
+
<option name="FILTERS">
|
|
88
|
+
<map>
|
|
89
|
+
<entry key="branch">
|
|
90
|
+
<value>
|
|
91
|
+
<list>
|
|
92
|
+
<option value="may-release-2022" />
|
|
93
|
+
</list>
|
|
94
|
+
</value>
|
|
95
|
+
</entry>
|
|
96
|
+
</map>
|
|
97
|
+
</option>
|
|
98
|
+
</State>
|
|
99
|
+
</value>
|
|
100
|
+
</entry>
|
|
101
|
+
</map>
|
|
102
|
+
</option>
|
|
103
|
+
<option name="RECENT_FILTERS">
|
|
104
|
+
<map>
|
|
105
|
+
<entry key="Branch">
|
|
106
|
+
<value>
|
|
107
|
+
<list>
|
|
108
|
+
<RecentGroup>
|
|
109
|
+
<option name="FILTER_VALUES">
|
|
110
|
+
<option value="may-release-2022" />
|
|
111
|
+
</option>
|
|
112
|
+
</RecentGroup>
|
|
113
|
+
</list>
|
|
114
|
+
</value>
|
|
115
|
+
</entry>
|
|
116
|
+
</map>
|
|
117
|
+
</option>
|
|
118
|
+
</component>
|
|
119
|
+
</project>
|
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**expirationYear** | **String** | Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) 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_**`=039`), if there is no expiration date on the card, use `2021`. #### 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 `pointOfSaleInformation.entryMode=keyed`. 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: - `001`: 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 `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` 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
10
|
**prefix** | **String** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional]
|
|
11
|
+
**hashedNumber** | **String** | #### Visa Platform Connect This API field will contain the SHA 256 hashed value of PAN. | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**code** | **String** | Reason the recurring payment transaction was declined. For some processors, this field is used only for Mastercard. For other processors, this field is used for Visa and Mastercard. And for other processors, this field is not implemented. Possible values: - `00`: Response not provided. - `01`: New account information is available. Obtain the new information. - `02`: Try again later. - `03`: Do not try again. Obtain another type of payment from the customer. - `04`: Problem with a token or a partial shipment indicator. - `21`: Recurring payment cancellation service. - `99`: An unknown value was returned from the processor. For processor-specific information, see the `auth_merchant_advice_code` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
|
|
7
7
|
**codeRaw** | **String** | Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code For processor-specific information, see the `auth_merchant_advice_code_raw` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
|
|
8
|
+
**nameMatch** | **String** | #### Visa Platform Connect The field contains will contain the Account Name Request Result for zero amount Authorization request. Valid values are: 00 = Name Match Performed 01 = Name Match not Performed 02 = Name Match not supported | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**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]
|
|
14
14
|
**phone** | **String** | Merchant phone as contact information for CNP transactions | [optional]
|
|
15
15
|
**url** | **String** | Address of company's website provided by merchant | [optional]
|
|
16
|
+
**countryOfOrigin** | **String** | #### Visa Platform Connect This field will indicate merchant country of origin | [optional]
|
|
16
17
|
|
|
17
18
|
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**invoiceDetails** | [**Ptsv2paymentsOrderInformationInvoiceDetails**](Ptsv2paymentsOrderInformationInvoiceDetails.md) | | [optional]
|
|
11
11
|
**shippingDetails** | [**Ptsv2paymentsOrderInformationShippingDetails**](Ptsv2paymentsOrderInformationShippingDetails.md) | | [optional]
|
|
12
12
|
**returnsAccepted** | **Boolean** | This is only needed when you are requesting both payment and DM service at same time. Boolean that indicates whether returns are accepted for this order. This field can contain one of the following values: - true: Returns are accepted for this order. - false: Returns are not accepted for this order. | [optional]
|
|
13
|
+
**isCryptocurrencyPurchase** | **String** | #### Visa Platform Connect : This API will contain the Flag that specifies whether the payment is for the purchase of cryptocurrency. Additional values to add : This API will contain the Flag that specifies whether the payment is for the purchase of cryptocurrency. valid values are - Y/y, true - N/n, false | [optional]
|
|
13
14
|
**preOrder** | **String** | Indicates whether cardholder is placing an order with a future availability or release date. This field can contain one of these values: - MERCHANDISE_AVAILABLE: Merchandise available - FUTURE_AVAILABILITY: Future availability | [optional]
|
|
14
15
|
**preOrderDate** | **String** | Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD | [optional]
|
|
15
16
|
**reordered** | **Boolean** | Indicates whether the cardholder is reordering previously purchased merchandise. This field can contain one of these values: - false: First time ordered - true: Reordered | [optional]
|
|
@@ -19,5 +19,6 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**salesSlipNumber** | **Number** | Transaction identifier that is generated. You have the option of printing the sales slip number on the receipt. This field is supported only on Cybersource through Visanet and JCN gateway. Optional field. #### Card Present processing message If you included this field in the request, the returned value is the value that you sent in the request. If you did not include this field in the request, the system generated this value for you. The difference between this reply field and the `processorInformation.systemTraceAuditNumber` field is that the system generates the system trace audit number (STAN), and you must print the receipt number on the receipt; whereas you can generate the sales slip number, and you can choose to print the sales slip number on the receipt. | [optional]
|
|
20
20
|
**invoiceDate** | **String** | Date of the tax calculation. Use format YYYYMMDD. You can provide a date in the past if you are calculating tax for a refund and want to know what the tax was on the date the order was placed. You can provide a date in the future if you are calculating the tax for a future date, such as an upcoming tax holiday. The default is the date, in Pacific time, that the bank receives the request. Keep this in mind if you are in a different time zone and want the tax calculated with the rates that are applicable on a specific date. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional]
|
|
21
21
|
**costCenter** | **String** | Cost centre of the merchant | [optional]
|
|
22
|
+
**issuerMessage** | **String** | Text message from the issuer. If you give the customer a receipt, display this value on the receipt. | [optional]
|
|
22
23
|
|
|
23
24
|
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
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: - `001`: 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 `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` 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
10
|
**cryptogram** | **String** | This field is used internally. | [optional]
|
|
11
11
|
**requestorId** | **String** | Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. #### PIN debit Optional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional]
|
|
12
|
-
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional]
|
|
12
|
+
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional]
|
|
13
13
|
**assuranceLevel** | **String** | Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. Returned by PIN debit credit or PIN debit purchase. | [optional]
|
|
14
14
|
**storageMethod** | **String** | Type of technology used in the device to store token data. Possible values: - `001`: Secure Element (SE). Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment credentials, a SE is tested against a set of requirements defined by the payment networks. **Note** This field is supported only for _FDC Compass_. - 002: Host Card Emulation (HCE). Emulation of a smart card by using software to create a virtual and exact representation of the card. Sensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database must meet very stringent security requirements that exceed PCI DSS. **Note** This field is supported only for _FDC Compass_. | [optional]
|
|
15
15
|
**securityCode** | **String** | Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. For details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
|
|
@@ -29,5 +29,6 @@ Name | Type | Description | Notes
|
|
|
29
29
|
**isDedicatedHardwareTerminal** | **String** | Type of mPOS device. Possible values: - 0: Dongle - 1: Phone or tablet This optional field is supported only for Mastercard transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 141 - Field: Mastercard mPOS Transaction 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]
|
|
30
30
|
**terminalModel** | **String** | This is the model name of the reader which is used to accept the payment. Possible values: - E3555 - P400 - A920 | [optional]
|
|
31
31
|
**terminalMake** | **String** | This is the manufacturer name of the reader which is used to accept the payment. Possible values: - PAX - Verifone - Ingenico | [optional]
|
|
32
|
+
**serviceCode** | **String** | #### Visa Platform Connect Mastercard service code that is included in the track data. You can extract the service code from the track data and provide it in this API field. This field is supported only for Mastercard on Visa Platform Connect. | [optional]
|
|
32
33
|
|
|
33
34
|
|
|
@@ -6,7 +6,8 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**tags** | **String** | EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Note** 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 processing is available only on FDC Nashville Global. **Important** The following tags contain sensitive information and **must not** be included in this field: - `56`: Track 1 equivalent data - `57`: Track 2 equivalent data - `5A`: Application PAN - `5F20`: Cardholder name - `5F24`: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX) - `99`: Transaction PIN - `9F0B`: Cardholder name (extended) - `9F1F`: Track 1 discretionary data - `9F20`: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - `95`: Terminal verification results - `9F10`: Issuer application data - `9F26`: Application cryptogram #### CyberSource through VisaNet - In Japan: 199 bytes - In other countries: String (252) #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### JCN Gateway The following tags must be included: - `4F`: Application identifier - `84`: Dedicated file name Data length: 199 bytes #### All other processors: String (999) #### Used by Authorization: Optional Authorization Reversal: Optional Credit: Optional PIN Debit processing (purchase, credit and reversal): Optional | [optional]
|
|
7
7
|
**cardholderVerificationMethodUsed** | **Number** | Method that was used to verify the cardholder's identity. Possible values: - `0`: No verification - `1`: Signature This field is supported only on **American Express Direct**. | [optional]
|
|
8
8
|
**cardSequenceNumber** | **String** | Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request. **Note** 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 processing is available only on CyberSource through VisaNet and FDC Nashville Global. #### Used by Authorization: Optional PIN Debit processing: Optional #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional]
|
|
9
|
-
**fallback** | **Boolean** | Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - `true`: Fallback method was used. - `false` (default): Fallback method was not used. This field is supported only on American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet, FDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX. | [optional]
|
|
10
|
-
**fallbackCondition** | **Number** | Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons: - Technical failure: the EMV terminal or EMV card cannot read and process chip data. - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you. Possible values: - `1`: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the
|
|
9
|
+
**fallback** | **Boolean** | Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - `true`: Fallback method was used. - `false` (default): Fallback method was not used. This field is supported only on American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet, FDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX. | [optional]
|
|
10
|
+
**fallbackCondition** | **Number** | Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons: - Technical failure: the EMV terminal or EMV card cannot read and process chip data. - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you. Possible values: - `1`: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal either used information from a successful chip read or it was not a chip transaction. - `2`: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful. This field is supported only on **GPN** and **JCN Gateway**. **NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. | [optional]
|
|
11
|
+
**isRepeat** | **String** | #### Visa Platform Connect Value 1 indicates this transaction is intentionally duplicated The field contains value “1” which indicates that merchant has intentionally duplicated single tap transaction. Merchant is intentionally sending a duplicate auth request for a single tap txn because the issuer requested a PIN. | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**authType** | **String** | Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional]
|
|
7
|
+
**panReturnIndicator** | **String** | #### Visa Platform Connect The field contains the PAN translation indicator for American Express Contactless Transaction. Valid value is 1- Expresspay Translation, PAN request 2- Expresspay Translation, PAN and Expiry date request | [optional]
|
|
7
8
|
**verbalAuthCode** | **String** | Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). | [optional]
|
|
8
9
|
**verbalAuthTransactionId** | **String** | Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of `000000000000000` (15 zeros). | [optional]
|
|
9
10
|
**authIndicator** | **String** | Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. #### Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. #### CyberSource through VisaNet When the value for this field is 0, it corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. | [optional]
|
|
@@ -4,5 +4,6 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**preApprovalToken** | **String** | Token received in original session service. | [optional]
|
|
7
|
+
**authorizationOptions** | [**Ptsv2paymentsProcessorInformationAuthorizationOptions**](Ptsv2paymentsProcessorInformationAuthorizationOptions.md) | | [optional]
|
|
7
8
|
|
|
8
9
|
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CyberSource.Ptsv2paymentsProcessorInformationAuthorizationOptions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**panReturnIndicator** | **String** | #### Visa Platform Connect The field contains the PAN translation indicator for American Express Contactless Transaction. Valid value is 1- Expresspay Translation, PAN request 2- Expresspay Translation, PAN and Expiry date request | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**tags** | **String** | EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Note** 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 processing is available only on FDC Nashville Global. **Important** The following tags contain sensitive information and **must not** be included in this field: - `56`: Track 1 equivalent data - `57`: Track 2 equivalent data - `5A`: Application PAN - `5F20`: Cardholder name - `5F24`: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX) - `99`: Transaction PIN - `9F0B`: Cardholder name (extended) - `9F1F`: Track 1 discretionary data - `9F20`: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - `95`: Terminal verification results - `9F10`: Issuer application data - `9F26`: Application cryptogram #### CyberSource through VisaNet - In Japan: 199 bytes - In other countries: String (252) #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### JCN Gateway The following tags must be included: - `4F`: Application identifier - `84`: Dedicated file name Data length: 199 bytes #### All other processors: String (999) #### Used by Authorization: Optional Authorization Reversal: Optional Credit: Optional PIN Debit processing (purchase, credit and reversal): Optional | [optional]
|
|
7
|
-
**fallback** | **Boolean** | Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - `true`: Fallback method was used. - `false` (default): Fallback method was not used. This field is supported only on American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet, FDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX. | [optional]
|
|
7
|
+
**fallback** | **Boolean** | Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - `true`: Fallback method was used. - `false` (default): Fallback method was not used. This field is supported only on American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet, FDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX. | [optional]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CyberSource.Ptsv2paymentsidvoidsOrderInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**amountDetails** | [**Ptsv2paymentsidreversalsReversalInformationAmountDetails**](Ptsv2paymentsidreversalsReversalInformationAmountDetails.md) | | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**amountDetails** | [**Ptsv2payoutsOrderInformationAmountDetails**](Ptsv2payoutsOrderInformationAmountDetails.md) | | [optional]
|
|
7
7
|
**billTo** | [**Ptsv2payoutsOrderInformationBillTo**](Ptsv2payoutsOrderInformationBillTo.md) | | [optional]
|
|
8
|
+
**isCryptocurrencyPurchase** | **String** | #### Visa Platform Connect : This API will contain the Flag that specifies whether the payment is for the purchase of cryptocurrency. Additional values to add : This API will contain the Flag that specifies whether the payment is for the purchase of cryptocurrency. valid values are - Y/y, true - N/n, false | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**payoutsOptions** | [**Ptsv2payoutsProcessingInformationPayoutsOptions**](Ptsv2payoutsProcessingInformationPayoutsOptions.md) | | [optional]
|
|
11
11
|
**transactionReason** | **String** | Transaction reason code. | [optional]
|
|
12
12
|
**purposeOfPayment** | **String** | This will send purpose of funds code for original credit transactions (OCTs). | [optional]
|
|
13
|
+
**fundingOptions** | [**Ptsv2payoutsProcessingInformationFundingOptions**](Ptsv2payoutsProcessingInformationFundingOptions.md) | | [optional]
|
|
13
14
|
|
|
14
15
|
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CyberSource.Ptsv2payoutsProcessingInformationFundingOptions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**initiator** | [**Ptsv2payoutsProcessingInformationFundingOptionsInitiator**](Ptsv2payoutsProcessingInformationFundingOptionsInitiator.md) | | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CyberSource.Ptsv2payoutsProcessingInformationFundingOptionsInitiator
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**type** | **String** | #### Visa Platform Connect : This API will contain a code that denotes whether the customer identification data belongs to the sender or the recipient. The valid values are: • S (Payer (sender)) • R (Payee (recipient)) | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -18,5 +18,8 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**phoneNumber** | **String** | Sender’s phone number. Required only for FDCCompass. | [optional]
|
|
19
19
|
**dateOfBirth** | **String** | Sender’s date of birth in YYYYMMDD format. Required only for FDCCompass. | [optional]
|
|
20
20
|
**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. | [optional]
|
|
21
|
+
**personalIdType** | **String** | #### Visa Platform Connect This tag will contain the type of sender identification. The valid values are: • BTHD (Date of birth) • CUID (Customer identification (unspecified)) • NTID (National identification) • PASN (Passport number) • DRLN (Driver license) • TXIN (Tax identification) • CPNY (Company registration number) • PRXY (Proxy identification) • SSNB (Social security number) • ARNB (Alien registration number) • LAWE (Law enforcement identification) • MILI (Military identification) • TRVL (Travel identification (non-passport)) • EMAL (Email) • PHON (Phone number) | [optional]
|
|
22
|
+
**type** | **String** | #### Visa Platform Connect This tag will denote whether the tax ID is a business or individual tax ID when personal ID Type contains the value of TXIN (Tax identification). The valid values are: • B (Business) • I (Individual) | [optional]
|
|
23
|
+
**identificationNumber** | **String** | #### Visa Platform Connect This tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender. | [optional]
|
|
21
24
|
|
|
22
25
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional]
|
|
6
|
+
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional]
|
|
7
7
|
**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: - `001`: 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 `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` 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]
|
|
8
8
|
**expirationMonth** | **String** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) 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 (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
|
|
9
9
|
**expirationYear** | **String** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) 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 (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional]
|
|
6
|
+
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional]
|
|
7
7
|
**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: - `001`: 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 `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` 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 |
|
|
8
8
|
**expirationMonth** | **String** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) 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 (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) |
|
|
9
9
|
**expirationYear** | **String** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) 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 (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. |
|
|
6
|
+
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. |
|
|
7
7
|
**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: - `001`: 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 `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` 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 |
|
|
8
8
|
**expirationMonth** | **String** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) 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 (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) |
|
|
9
9
|
**expirationYear** | **String** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) 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 (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional]
|
|
6
|
+
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional]
|
|
7
7
|
**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: - `001`: 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 `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` 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 `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` 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]
|
|
8
8
|
**_number** | **String** | Customer’s payment network token value. | [optional]
|
|
9
9
|
**expirationMonth** | **String** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) 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 (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
|
|
@@ -9,6 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**authorizedAmount** | **String** | Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API. | [optional]
|
|
10
10
|
**settlementAmount** | **String** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account. This field is returned for OCT transactions. | [optional]
|
|
11
11
|
**settlementCurrency** | **String** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions. | [optional]
|
|
12
|
-
**surcharge** | [**
|
|
12
|
+
**surcharge** | [**Ptsv2payoutsOrderInformationAmountDetailsSurcharge**](Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md) | | [optional]
|
|
13
13
|
|
|
14
14
|
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**clientReferenceInformation** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional]
|
|
7
7
|
**paymentInformation** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional]
|
|
8
|
+
**orderInformation** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**clientReferenceInformation** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional]
|
|
7
7
|
**paymentInformation** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional]
|
|
8
|
+
**orderInformation** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**clientReferenceInformation** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional]
|
|
7
7
|
**paymentInformation** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional]
|
|
8
|
+
**orderInformation** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**clientReferenceInformation** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional]
|
|
7
7
|
**paymentInformation** | [**Ptsv2paymentsidvoidsPaymentInformation**](Ptsv2paymentsidvoidsPaymentInformation.md) | | [optional]
|
|
8
|
+
**orderInformation** | [**Ptsv2paymentsidvoidsOrderInformation**](Ptsv2paymentsidvoidsOrderInformation.md) | | [optional]
|
|
8
9
|
|
|
9
10
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cybersource-rest-client",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.38",
|
|
4
4
|
"description": "Node.js SDK for the CyberSource REST API",
|
|
5
5
|
"author": "developer@cybersource.com",
|
|
6
6
|
"license": "CyberSource",
|
|
@@ -29,11 +29,12 @@
|
|
|
29
29
|
"nodeJS"
|
|
30
30
|
],
|
|
31
31
|
"devDependencies": {
|
|
32
|
+
"@sinonjs/formatio": "3.0.0",
|
|
33
|
+
"expect.js": "~0.3.1",
|
|
34
|
+
"jwk-to-pem": "^2.0.5",
|
|
32
35
|
"mocha": "^5.2.0",
|
|
33
36
|
"mocha-sonarqube-reporter": "^1.0.1",
|
|
34
37
|
"nyc": "^12.0.2",
|
|
35
|
-
"sonar-scanner": "^3.1.0"
|
|
36
|
-
"@sinonjs/formatio": "3.0.0",
|
|
37
|
-
"expect.js": "~0.3.1"
|
|
38
|
+
"sonar-scanner": "^3.1.0"
|
|
38
39
|
}
|
|
39
40
|
}
|
|
@@ -70,6 +70,9 @@
|
|
|
70
70
|
this.getChargebackDetails = function(startTime, endTime, opts, callback) {
|
|
71
71
|
opts = opts || {};
|
|
72
72
|
var postBody = null;
|
|
73
|
+
if ('GET' == 'POST') {
|
|
74
|
+
postBody = '{}';
|
|
75
|
+
}
|
|
73
76
|
|
|
74
77
|
// verify the required parameter 'startTime' is set
|
|
75
78
|
if (startTime === undefined || startTime === null) {
|
|
@@ -70,6 +70,9 @@
|
|
|
70
70
|
this.getChargebackSummaries = function(startTime, endTime, opts, callback) {
|
|
71
71
|
opts = opts || {};
|
|
72
72
|
var postBody = null;
|
|
73
|
+
if ('GET' == 'POST') {
|
|
74
|
+
postBody = '{}';
|
|
75
|
+
}
|
|
73
76
|
|
|
74
77
|
// verify the required parameter 'startTime' is set
|
|
75
78
|
if (startTime === undefined || startTime === null) {
|
|
@@ -70,6 +70,9 @@
|
|
|
70
70
|
this.getConversionDetail = function(startTime, endTime, opts, callback) {
|
|
71
71
|
opts = opts || {};
|
|
72
72
|
var postBody = null;
|
|
73
|
+
if ('GET' == 'POST') {
|
|
74
|
+
postBody = '{}';
|
|
75
|
+
}
|
|
73
76
|
|
|
74
77
|
// verify the required parameter 'startTime' is set
|
|
75
78
|
if (startTime === undefined || startTime === null) {
|
package/src/api/CustomerApi.js
CHANGED
|
@@ -67,6 +67,9 @@
|
|
|
67
67
|
this.deleteCustomer = function(customerTokenId, opts, callback) {
|
|
68
68
|
opts = opts || {};
|
|
69
69
|
var postBody = null;
|
|
70
|
+
if ('DELETE' == 'POST') {
|
|
71
|
+
postBody = '{}';
|
|
72
|
+
}
|
|
70
73
|
|
|
71
74
|
// verify the required parameter 'customerTokenId' is set
|
|
72
75
|
if (customerTokenId === undefined || customerTokenId === null) {
|
|
@@ -116,6 +119,9 @@
|
|
|
116
119
|
this.getCustomer = function(customerTokenId, opts, callback) {
|
|
117
120
|
opts = opts || {};
|
|
118
121
|
var postBody = null;
|
|
122
|
+
if ('GET' == 'POST') {
|
|
123
|
+
postBody = '{}';
|
|
124
|
+
}
|
|
119
125
|
|
|
120
126
|
// verify the required parameter 'customerTokenId' is set
|
|
121
127
|
if (customerTokenId === undefined || customerTokenId === null) {
|