cybersource-rest-client 0.0.47 → 0.0.49

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 (87) hide show
  1. package/docs/BillingAgreementsApi.md +155 -0
  2. package/docs/CreateBillingAgreement.md +16 -0
  3. package/docs/CreateBundledDecisionManagerCaseRequest.md +1 -0
  4. package/docs/IntimateBillingAgreement.md +12 -0
  5. package/docs/InvoiceSettingsApi.md +2 -2
  6. package/docs/InvoicesApi.md +6 -6
  7. package/docs/ModifyBillingAgreement.md +16 -0
  8. package/docs/PlansApi.md +12 -20
  9. package/docs/PtsV2CreditsPost201Response1.md +12 -0
  10. package/docs/PtsV2CreditsPost201Response1InstallmentInformation.md +8 -0
  11. package/docs/PtsV2CreditsPost201Response1ProcessorInformation.md +9 -0
  12. package/docs/PtsV2PaymentsPost201Response.md +1 -0
  13. package/docs/PtsV2PaymentsPost201ResponseEmbeddedActions.md +12 -0
  14. package/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE.md +10 -0
  15. package/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.md +10 -0
  16. package/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION.md +10 -0
  17. package/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING.md +10 -0
  18. package/docs/Ptsv2billingagreementsAggregatorInformation.md +9 -0
  19. package/docs/Ptsv2billingagreementsConsumerAuthenticationInformation.md +11 -0
  20. package/docs/Ptsv2billingagreementsDeviceInformation.md +10 -0
  21. package/docs/Ptsv2billingagreementsInstallmentInformation.md +16 -0
  22. package/docs/Ptsv2billingagreementsMerchantInformation.md +11 -0
  23. package/docs/Ptsv2billingagreementsMerchantInformationMerchantDescriptor.md +11 -0
  24. package/docs/Ptsv2billingagreementsOrderInformation.md +9 -0
  25. package/docs/Ptsv2billingagreementsOrderInformationBillTo.md +20 -0
  26. package/docs/Ptsv2billingagreementsPaymentInformation.md +9 -0
  27. package/docs/Ptsv2billingagreementsPaymentInformationCard.md +12 -0
  28. package/docs/Ptsv2billingagreementsPaymentInformationTokenizedCard.md +13 -0
  29. package/docs/Ptsv2billingagreementsProcessingInformation.md +9 -0
  30. package/docs/Ptsv2paymentsOrderInformation.md +1 -0
  31. package/docs/Ptsv2paymentsProcessingInformation.md +1 -1
  32. package/docs/Ptsv2paymentsRecipientInformation.md +1 -0
  33. package/docs/Riskv1authenticationsetupsTokenInformation.md +1 -0
  34. package/docs/Riskv1decisionsOrderInformation.md +1 -0
  35. package/docs/Riskv1decisionsTokenInformation.md +8 -0
  36. package/docs/SubscriptionsApi.md +14 -26
  37. package/docs/TssV2TransactionsGet200Response.md +1 -0
  38. package/docs/TssV2TransactionsPost201Response.md +0 -1
  39. package/docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md +2 -0
  40. package/docs/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md +8 -0
  41. package/docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md +2 -0
  42. package/docs/ValidateRequest.md +1 -0
  43. package/package.json +1 -1
  44. package/src/ApiClient.js +3 -1
  45. package/src/api/BillingAgreementsApi.js +203 -0
  46. package/src/api/InvoiceSettingsApi.js +2 -2
  47. package/src/api/InvoicesApi.js +6 -6
  48. package/src/api/PlansApi.js +18 -18
  49. package/src/api/SubscriptionsApi.js +23 -23
  50. package/src/index.js +133 -3
  51. package/src/model/CreateBillingAgreement.js +145 -0
  52. package/src/model/CreateBundledDecisionManagerCaseRequest.js +12 -4
  53. package/src/model/IntimateBillingAgreement.js +113 -0
  54. package/src/model/ModifyBillingAgreement.js +145 -0
  55. package/src/model/PtsV2CreditsPost201Response1.js +116 -0
  56. package/src/model/PtsV2CreditsPost201Response1InstallmentInformation.js +82 -0
  57. package/src/model/PtsV2CreditsPost201Response1ProcessorInformation.js +91 -0
  58. package/src/model/PtsV2PaymentsPost201Response.js +12 -4
  59. package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActions.js +114 -0
  60. package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE.js +100 -0
  61. package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.js +100 -0
  62. package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION.js +100 -0
  63. package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING.js +100 -0
  64. package/src/model/Ptsv2billingagreementsAggregatorInformation.js +90 -0
  65. package/src/model/Ptsv2billingagreementsConsumerAuthenticationInformation.js +109 -0
  66. package/src/model/Ptsv2billingagreementsDeviceInformation.js +100 -0
  67. package/src/model/Ptsv2billingagreementsInstallmentInformation.js +154 -0
  68. package/src/model/Ptsv2billingagreementsMerchantInformation.js +108 -0
  69. package/src/model/Ptsv2billingagreementsMerchantInformationMerchantDescriptor.js +109 -0
  70. package/src/model/Ptsv2billingagreementsOrderInformation.js +89 -0
  71. package/src/model/Ptsv2billingagreementsOrderInformationBillTo.js +190 -0
  72. package/src/model/Ptsv2billingagreementsPaymentInformation.js +89 -0
  73. package/src/model/Ptsv2billingagreementsPaymentInformationCard.js +118 -0
  74. package/src/model/Ptsv2billingagreementsPaymentInformationTokenizedCard.js +127 -0
  75. package/src/model/Ptsv2billingagreementsProcessingInformation.js +91 -0
  76. package/src/model/Ptsv2paymentsOrderInformation.js +9 -0
  77. package/src/model/Ptsv2paymentsProcessingInformation.js +1 -1
  78. package/src/model/Ptsv2paymentsRecipientInformation.js +9 -0
  79. package/src/model/Riskv1authenticationsetupsTokenInformation.js +9 -0
  80. package/src/model/Riskv1decisionsOrderInformation.js +9 -0
  81. package/src/model/Riskv1decisionsTokenInformation.js +82 -0
  82. package/src/model/TssV2TransactionsGet200Response.js +9 -0
  83. package/src/model/TssV2TransactionsPost201Response.js +0 -9
  84. package/src/model/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.js +18 -0
  85. package/src/model/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.js +82 -0
  86. package/src/model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.js +21 -4
  87. package/src/model/ValidateRequest.js +12 -4
@@ -0,0 +1,89 @@
1
+ /**
2
+ * CyberSource Merged Spec
3
+ * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
4
+ *
5
+ * OpenAPI spec version: 0.0.1
6
+ *
7
+ * NOTE: This class is auto generated by the swagger code generator program.
8
+ * https://github.com/swagger-api/swagger-codegen.git
9
+ *
10
+ * Swagger Codegen version: 2.3.0
11
+ *
12
+ * Do not edit the class manually.
13
+ *
14
+ */
15
+
16
+ (function(root, factory) {
17
+ if (typeof define === 'function' && define.amd) {
18
+ // AMD. Register as an anonymous module.
19
+ define(['ApiClient', 'model/Ptsv2billingagreementsOrderInformationBillTo', 'model/Ptsv2paymentsidreversalsReversalInformationAmountDetails'], factory);
20
+ } else if (typeof module === 'object' && module.exports) {
21
+ // CommonJS-like environments that support module.exports, like Node.
22
+ module.exports = factory(require('../ApiClient'), require('./Ptsv2billingagreementsOrderInformationBillTo'), require('./Ptsv2paymentsidreversalsReversalInformationAmountDetails'));
23
+ } else {
24
+ // Browser globals (root is window)
25
+ if (!root.CyberSource) {
26
+ root.CyberSource = {};
27
+ }
28
+ root.CyberSource.Ptsv2billingagreementsOrderInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2billingagreementsOrderInformationBillTo, root.CyberSource.Ptsv2paymentsidreversalsReversalInformationAmountDetails);
29
+ }
30
+ }(this, function(ApiClient, Ptsv2billingagreementsOrderInformationBillTo, Ptsv2paymentsidreversalsReversalInformationAmountDetails) {
31
+ 'use strict';
32
+
33
+
34
+
35
+
36
+ /**
37
+ * The Ptsv2billingagreementsOrderInformation model module.
38
+ * @module model/Ptsv2billingagreementsOrderInformation
39
+ * @version 0.0.1
40
+ */
41
+
42
+ /**
43
+ * Constructs a new <code>Ptsv2billingagreementsOrderInformation</code>.
44
+ * @alias module:model/Ptsv2billingagreementsOrderInformation
45
+ * @class
46
+ */
47
+ var exports = function() {
48
+ var _this = this;
49
+
50
+
51
+
52
+ };
53
+
54
+ /**
55
+ * Constructs a <code>Ptsv2billingagreementsOrderInformation</code> from a plain JavaScript object, optionally creating a new instance.
56
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
57
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
58
+ * @param {module:model/Ptsv2billingagreementsOrderInformation} obj Optional instance to populate.
59
+ * @return {module:model/Ptsv2billingagreementsOrderInformation} The populated <code>Ptsv2billingagreementsOrderInformation</code> instance.
60
+ */
61
+ exports.constructFromObject = function(data, obj) {
62
+ if (data) {
63
+ obj = obj || new exports();
64
+
65
+ if (data.hasOwnProperty('amountDetails')) {
66
+ obj['amountDetails'] = Ptsv2paymentsidreversalsReversalInformationAmountDetails.constructFromObject(data['amountDetails']);
67
+ }
68
+ if (data.hasOwnProperty('billTo')) {
69
+ obj['billTo'] = Ptsv2billingagreementsOrderInformationBillTo.constructFromObject(data['billTo']);
70
+ }
71
+ }
72
+ return obj;
73
+ }
74
+
75
+ /**
76
+ * @member {module:model/Ptsv2paymentsidreversalsReversalInformationAmountDetails} amountDetails
77
+ */
78
+ exports.prototype['amountDetails'] = undefined;
79
+ /**
80
+ * @member {module:model/Ptsv2billingagreementsOrderInformationBillTo} billTo
81
+ */
82
+ exports.prototype['billTo'] = undefined;
83
+
84
+
85
+
86
+ return exports;
87
+ }));
88
+
89
+
@@ -0,0 +1,190 @@
1
+ /**
2
+ * CyberSource Merged Spec
3
+ * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
4
+ *
5
+ * OpenAPI spec version: 0.0.1
6
+ *
7
+ * NOTE: This class is auto generated by the swagger code generator program.
8
+ * https://github.com/swagger-api/swagger-codegen.git
9
+ *
10
+ * Swagger Codegen version: 2.3.0
11
+ *
12
+ * Do not edit the class manually.
13
+ *
14
+ */
15
+
16
+ (function(root, factory) {
17
+ if (typeof define === 'function' && define.amd) {
18
+ // AMD. Register as an anonymous module.
19
+ define(['ApiClient'], factory);
20
+ } else if (typeof module === 'object' && module.exports) {
21
+ // CommonJS-like environments that support module.exports, like Node.
22
+ module.exports = factory(require('../ApiClient'));
23
+ } else {
24
+ // Browser globals (root is window)
25
+ if (!root.CyberSource) {
26
+ root.CyberSource = {};
27
+ }
28
+ root.CyberSource.Ptsv2billingagreementsOrderInformationBillTo = factory(root.CyberSource.ApiClient);
29
+ }
30
+ }(this, function(ApiClient) {
31
+ 'use strict';
32
+
33
+
34
+
35
+
36
+ /**
37
+ * The Ptsv2billingagreementsOrderInformationBillTo model module.
38
+ * @module model/Ptsv2billingagreementsOrderInformationBillTo
39
+ * @version 0.0.1
40
+ */
41
+
42
+ /**
43
+ * Constructs a new <code>Ptsv2billingagreementsOrderInformationBillTo</code>.
44
+ * @alias module:model/Ptsv2billingagreementsOrderInformationBillTo
45
+ * @class
46
+ */
47
+ var exports = function() {
48
+ var _this = this;
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+ };
64
+
65
+ /**
66
+ * Constructs a <code>Ptsv2billingagreementsOrderInformationBillTo</code> from a plain JavaScript object, optionally creating a new instance.
67
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
68
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
69
+ * @param {module:model/Ptsv2billingagreementsOrderInformationBillTo} obj Optional instance to populate.
70
+ * @return {module:model/Ptsv2billingagreementsOrderInformationBillTo} The populated <code>Ptsv2billingagreementsOrderInformationBillTo</code> instance.
71
+ */
72
+ exports.constructFromObject = function(data, obj) {
73
+ if (data) {
74
+ obj = obj || new exports();
75
+
76
+ if (data.hasOwnProperty('address1')) {
77
+ obj['address1'] = ApiClient.convertToType(data['address1'], 'String');
78
+ }
79
+ if (data.hasOwnProperty('address2')) {
80
+ obj['address2'] = ApiClient.convertToType(data['address2'], 'String');
81
+ }
82
+ if (data.hasOwnProperty('administrativeArea')) {
83
+ obj['administrativeArea'] = ApiClient.convertToType(data['administrativeArea'], 'String');
84
+ }
85
+ if (data.hasOwnProperty('buildingNumber')) {
86
+ obj['buildingNumber'] = ApiClient.convertToType(data['buildingNumber'], 'String');
87
+ }
88
+ if (data.hasOwnProperty('company')) {
89
+ obj['company'] = ApiClient.convertToType(data['company'], 'String');
90
+ }
91
+ if (data.hasOwnProperty('country')) {
92
+ obj['country'] = ApiClient.convertToType(data['country'], 'String');
93
+ }
94
+ if (data.hasOwnProperty('district')) {
95
+ obj['district'] = ApiClient.convertToType(data['district'], 'String');
96
+ }
97
+ if (data.hasOwnProperty('email')) {
98
+ obj['email'] = ApiClient.convertToType(data['email'], 'String');
99
+ }
100
+ if (data.hasOwnProperty('firstName')) {
101
+ obj['firstName'] = ApiClient.convertToType(data['firstName'], 'String');
102
+ }
103
+ if (data.hasOwnProperty('lastName')) {
104
+ obj['lastName'] = ApiClient.convertToType(data['lastName'], 'String');
105
+ }
106
+ if (data.hasOwnProperty('locality')) {
107
+ obj['locality'] = ApiClient.convertToType(data['locality'], 'String');
108
+ }
109
+ if (data.hasOwnProperty('phoneNumber')) {
110
+ obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'String');
111
+ }
112
+ if (data.hasOwnProperty('postalCode')) {
113
+ obj['postalCode'] = ApiClient.convertToType(data['postalCode'], 'String');
114
+ }
115
+ }
116
+ return obj;
117
+ }
118
+
119
+ /**
120
+ * Payment card billing street address as it appears on the credit card issuer’s records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
121
+ * @member {String} address1
122
+ */
123
+ exports.prototype['address1'] = undefined;
124
+ /**
125
+ * Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate `orderInformation.billTo.address1` and `orderInformation.billTo.address2`, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60)
126
+ * @member {String} address2
127
+ */
128
+ exports.prototype['address2'] = undefined;
129
+ /**
130
+ * State or province of the billing address. 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). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
131
+ * @member {String} administrativeArea
132
+ */
133
+ exports.prototype['administrativeArea'] = undefined;
134
+ /**
135
+ * Building number in the street address. For example, if the street address is: Rua da Quitanda 187 then the building number is 187. This field is supported only for: - Cielo transactions. - Redecard customer validation with CyberSource Latin American Processing.
136
+ * @member {String} buildingNumber
137
+ */
138
+ exports.prototype['buildingNumber'] = undefined;
139
+ /**
140
+ * Company's Name, e.g. VISA
141
+ * @member {String} company
142
+ */
143
+ exports.prototype['company'] = undefined;
144
+ /**
145
+ * Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
146
+ * @member {String} country
147
+ */
148
+ exports.prototype['country'] = undefined;
149
+ /**
150
+ * Customer’s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on **Cielo**.
151
+ * @member {String} district
152
+ */
153
+ exports.prototype['district'] = undefined;
154
+ /**
155
+ * Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **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_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
156
+ * @member {String} email
157
+ */
158
+ exports.prototype['email'] = undefined;
159
+ /**
160
+ * Customer’s first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
161
+ * @member {String} firstName
162
+ */
163
+ exports.prototype['firstName'] = undefined;
164
+ /**
165
+ * Customer’s last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
166
+ * @member {String} lastName
167
+ */
168
+ exports.prototype['lastName'] = undefined;
169
+ /**
170
+ * Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
171
+ * @member {String} locality
172
+ */
173
+ exports.prototype['locality'] = undefined;
174
+ /**
175
+ * Customer’s phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used.
176
+ * @member {String} phoneNumber
177
+ */
178
+ exports.prototype['phoneNumber'] = undefined;
179
+ /**
180
+ * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field.
181
+ * @member {String} postalCode
182
+ */
183
+ exports.prototype['postalCode'] = undefined;
184
+
185
+
186
+
187
+ return exports;
188
+ }));
189
+
190
+
@@ -0,0 +1,89 @@
1
+ /**
2
+ * CyberSource Merged Spec
3
+ * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
4
+ *
5
+ * OpenAPI spec version: 0.0.1
6
+ *
7
+ * NOTE: This class is auto generated by the swagger code generator program.
8
+ * https://github.com/swagger-api/swagger-codegen.git
9
+ *
10
+ * Swagger Codegen version: 2.3.0
11
+ *
12
+ * Do not edit the class manually.
13
+ *
14
+ */
15
+
16
+ (function(root, factory) {
17
+ if (typeof define === 'function' && define.amd) {
18
+ // AMD. Register as an anonymous module.
19
+ define(['ApiClient', 'model/Ptsv2billingagreementsPaymentInformationCard', 'model/Ptsv2billingagreementsPaymentInformationTokenizedCard'], factory);
20
+ } else if (typeof module === 'object' && module.exports) {
21
+ // CommonJS-like environments that support module.exports, like Node.
22
+ module.exports = factory(require('../ApiClient'), require('./Ptsv2billingagreementsPaymentInformationCard'), require('./Ptsv2billingagreementsPaymentInformationTokenizedCard'));
23
+ } else {
24
+ // Browser globals (root is window)
25
+ if (!root.CyberSource) {
26
+ root.CyberSource = {};
27
+ }
28
+ root.CyberSource.Ptsv2billingagreementsPaymentInformation = factory(root.CyberSource.ApiClient, root.CyberSource.Ptsv2billingagreementsPaymentInformationCard, root.CyberSource.Ptsv2billingagreementsPaymentInformationTokenizedCard);
29
+ }
30
+ }(this, function(ApiClient, Ptsv2billingagreementsPaymentInformationCard, Ptsv2billingagreementsPaymentInformationTokenizedCard) {
31
+ 'use strict';
32
+
33
+
34
+
35
+
36
+ /**
37
+ * The Ptsv2billingagreementsPaymentInformation model module.
38
+ * @module model/Ptsv2billingagreementsPaymentInformation
39
+ * @version 0.0.1
40
+ */
41
+
42
+ /**
43
+ * Constructs a new <code>Ptsv2billingagreementsPaymentInformation</code>.
44
+ * @alias module:model/Ptsv2billingagreementsPaymentInformation
45
+ * @class
46
+ */
47
+ var exports = function() {
48
+ var _this = this;
49
+
50
+
51
+
52
+ };
53
+
54
+ /**
55
+ * Constructs a <code>Ptsv2billingagreementsPaymentInformation</code> from a plain JavaScript object, optionally creating a new instance.
56
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
57
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
58
+ * @param {module:model/Ptsv2billingagreementsPaymentInformation} obj Optional instance to populate.
59
+ * @return {module:model/Ptsv2billingagreementsPaymentInformation} The populated <code>Ptsv2billingagreementsPaymentInformation</code> instance.
60
+ */
61
+ exports.constructFromObject = function(data, obj) {
62
+ if (data) {
63
+ obj = obj || new exports();
64
+
65
+ if (data.hasOwnProperty('card')) {
66
+ obj['card'] = Ptsv2billingagreementsPaymentInformationCard.constructFromObject(data['card']);
67
+ }
68
+ if (data.hasOwnProperty('tokenizedCard')) {
69
+ obj['tokenizedCard'] = Ptsv2billingagreementsPaymentInformationTokenizedCard.constructFromObject(data['tokenizedCard']);
70
+ }
71
+ }
72
+ return obj;
73
+ }
74
+
75
+ /**
76
+ * @member {module:model/Ptsv2billingagreementsPaymentInformationCard} card
77
+ */
78
+ exports.prototype['card'] = undefined;
79
+ /**
80
+ * @member {module:model/Ptsv2billingagreementsPaymentInformationTokenizedCard} tokenizedCard
81
+ */
82
+ exports.prototype['tokenizedCard'] = undefined;
83
+
84
+
85
+
86
+ return exports;
87
+ }));
88
+
89
+
@@ -0,0 +1,118 @@
1
+ /**
2
+ * CyberSource Merged Spec
3
+ * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
4
+ *
5
+ * OpenAPI spec version: 0.0.1
6
+ *
7
+ * NOTE: This class is auto generated by the swagger code generator program.
8
+ * https://github.com/swagger-api/swagger-codegen.git
9
+ *
10
+ * Swagger Codegen version: 2.3.0
11
+ *
12
+ * Do not edit the class manually.
13
+ *
14
+ */
15
+
16
+ (function(root, factory) {
17
+ if (typeof define === 'function' && define.amd) {
18
+ // AMD. Register as an anonymous module.
19
+ define(['ApiClient'], factory);
20
+ } else if (typeof module === 'object' && module.exports) {
21
+ // CommonJS-like environments that support module.exports, like Node.
22
+ module.exports = factory(require('../ApiClient'));
23
+ } else {
24
+ // Browser globals (root is window)
25
+ if (!root.CyberSource) {
26
+ root.CyberSource = {};
27
+ }
28
+ root.CyberSource.Ptsv2billingagreementsPaymentInformationCard = factory(root.CyberSource.ApiClient);
29
+ }
30
+ }(this, function(ApiClient) {
31
+ 'use strict';
32
+
33
+
34
+
35
+
36
+ /**
37
+ * The Ptsv2billingagreementsPaymentInformationCard model module.
38
+ * @module model/Ptsv2billingagreementsPaymentInformationCard
39
+ * @version 0.0.1
40
+ */
41
+
42
+ /**
43
+ * Constructs a new <code>Ptsv2billingagreementsPaymentInformationCard</code>.
44
+ * @alias module:model/Ptsv2billingagreementsPaymentInformationCard
45
+ * @class
46
+ */
47
+ var exports = function() {
48
+ var _this = this;
49
+
50
+
51
+
52
+
53
+
54
+
55
+ };
56
+
57
+ /**
58
+ * Constructs a <code>Ptsv2billingagreementsPaymentInformationCard</code> from a plain JavaScript object, optionally creating a new instance.
59
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
60
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
61
+ * @param {module:model/Ptsv2billingagreementsPaymentInformationCard} obj Optional instance to populate.
62
+ * @return {module:model/Ptsv2billingagreementsPaymentInformationCard} The populated <code>Ptsv2billingagreementsPaymentInformationCard</code> instance.
63
+ */
64
+ exports.constructFromObject = function(data, obj) {
65
+ if (data) {
66
+ obj = obj || new exports();
67
+
68
+ if (data.hasOwnProperty('expirationMonth')) {
69
+ obj['expirationMonth'] = ApiClient.convertToType(data['expirationMonth'], 'String');
70
+ }
71
+ if (data.hasOwnProperty('expirationYear')) {
72
+ obj['expirationYear'] = ApiClient.convertToType(data['expirationYear'], 'String');
73
+ }
74
+ if (data.hasOwnProperty('number')) {
75
+ obj['number'] = ApiClient.convertToType(data['number'], 'String');
76
+ }
77
+ if (data.hasOwnProperty('securityCode')) {
78
+ obj['securityCode'] = ApiClient.convertToType(data['securityCode'], 'String');
79
+ }
80
+ if (data.hasOwnProperty('type')) {
81
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
82
+ }
83
+ }
84
+ return obj;
85
+ }
86
+
87
+ /**
88
+ * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. 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 (`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 (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### 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.
89
+ * @member {String} expirationMonth
90
+ */
91
+ exports.prototype['expirationMonth'] = undefined;
92
+ /**
93
+ * 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.
94
+ * @member {String} expirationYear
95
+ */
96
+ exports.prototype['expirationYear'] = undefined;
97
+ /**
98
+ * The customer’s payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX 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. #### 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.
99
+ * @member {String} number
100
+ */
101
+ exports.prototype['number'] = undefined;
102
+ /**
103
+ * Card Verification Number. #### FDMS Nashville Required for American Express or if swiped; otherwise, optional. #### Ingenico ePayments Do not include this field when `commerceIndicator=recurring`. **Note** Ingenico ePayments was previously called _Global Collect_. #### TSYS Acquiring Solutions Optional if pointOfSaleInformation.entryMode=keyed; otherwise, not used. #### GPX Optional. #### All other processors: Optional.
104
+ * @member {String} securityCode
105
+ */
106
+ exports.prototype['securityCode'] = undefined;
107
+ /**
108
+ * 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 - '070': EFTPOS [^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
109
+ * @member {String} type
110
+ */
111
+ exports.prototype['type'] = undefined;
112
+
113
+
114
+
115
+ return exports;
116
+ }));
117
+
118
+
@@ -0,0 +1,127 @@
1
+ /**
2
+ * CyberSource Merged Spec
3
+ * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
4
+ *
5
+ * OpenAPI spec version: 0.0.1
6
+ *
7
+ * NOTE: This class is auto generated by the swagger code generator program.
8
+ * https://github.com/swagger-api/swagger-codegen.git
9
+ *
10
+ * Swagger Codegen version: 2.3.0
11
+ *
12
+ * Do not edit the class manually.
13
+ *
14
+ */
15
+
16
+ (function(root, factory) {
17
+ if (typeof define === 'function' && define.amd) {
18
+ // AMD. Register as an anonymous module.
19
+ define(['ApiClient'], factory);
20
+ } else if (typeof module === 'object' && module.exports) {
21
+ // CommonJS-like environments that support module.exports, like Node.
22
+ module.exports = factory(require('../ApiClient'));
23
+ } else {
24
+ // Browser globals (root is window)
25
+ if (!root.CyberSource) {
26
+ root.CyberSource = {};
27
+ }
28
+ root.CyberSource.Ptsv2billingagreementsPaymentInformationTokenizedCard = factory(root.CyberSource.ApiClient);
29
+ }
30
+ }(this, function(ApiClient) {
31
+ 'use strict';
32
+
33
+
34
+
35
+
36
+ /**
37
+ * The Ptsv2billingagreementsPaymentInformationTokenizedCard model module.
38
+ * @module model/Ptsv2billingagreementsPaymentInformationTokenizedCard
39
+ * @version 0.0.1
40
+ */
41
+
42
+ /**
43
+ * Constructs a new <code>Ptsv2billingagreementsPaymentInformationTokenizedCard</code>.
44
+ * @alias module:model/Ptsv2billingagreementsPaymentInformationTokenizedCard
45
+ * @class
46
+ */
47
+ var exports = function() {
48
+ var _this = this;
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+ };
57
+
58
+ /**
59
+ * Constructs a <code>Ptsv2billingagreementsPaymentInformationTokenizedCard</code> from a plain JavaScript object, optionally creating a new instance.
60
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
61
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
62
+ * @param {module:model/Ptsv2billingagreementsPaymentInformationTokenizedCard} obj Optional instance to populate.
63
+ * @return {module:model/Ptsv2billingagreementsPaymentInformationTokenizedCard} The populated <code>Ptsv2billingagreementsPaymentInformationTokenizedCard</code> instance.
64
+ */
65
+ exports.constructFromObject = function(data, obj) {
66
+ if (data) {
67
+ obj = obj || new exports();
68
+
69
+ if (data.hasOwnProperty('cryptogram')) {
70
+ obj['cryptogram'] = ApiClient.convertToType(data['cryptogram'], 'String');
71
+ }
72
+ if (data.hasOwnProperty('expirationMonth')) {
73
+ obj['expirationMonth'] = ApiClient.convertToType(data['expirationMonth'], 'String');
74
+ }
75
+ if (data.hasOwnProperty('expirationYear')) {
76
+ obj['expirationYear'] = ApiClient.convertToType(data['expirationYear'], 'String');
77
+ }
78
+ if (data.hasOwnProperty('number')) {
79
+ obj['number'] = ApiClient.convertToType(data['number'], 'String');
80
+ }
81
+ if (data.hasOwnProperty('transactionType')) {
82
+ obj['transactionType'] = ApiClient.convertToType(data['transactionType'], 'String');
83
+ }
84
+ if (data.hasOwnProperty('type')) {
85
+ obj['type'] = ApiClient.convertToType(data['type'], 'String');
86
+ }
87
+ }
88
+ return obj;
89
+ }
90
+
91
+ /**
92
+ * This field contains token information.
93
+ * @member {String} cryptogram
94
+ */
95
+ exports.prototype['cryptogram'] = undefined;
96
+ /**
97
+ * 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)
98
+ * @member {String} expirationMonth
99
+ */
100
+ exports.prototype['expirationMonth'] = undefined;
101
+ /**
102
+ * 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)
103
+ * @member {String} expirationYear
104
+ */
105
+ exports.prototype['expirationYear'] = undefined;
106
+ /**
107
+ * Customer’s payment network token value.
108
+ * @member {String} number
109
+ */
110
+ exports.prototype['number'] = undefined;
111
+ /**
112
+ * 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`: For Rupay and 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.
113
+ * @member {String} transactionType
114
+ */
115
+ exports.prototype['transactionType'] = undefined;
116
+ /**
117
+ * 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 - '070': EFTPOS [^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
118
+ * @member {String} type
119
+ */
120
+ exports.prototype['type'] = undefined;
121
+
122
+
123
+
124
+ return exports;
125
+ }));
126
+
127
+