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.
- package/docs/BillingAgreementsApi.md +155 -0
- package/docs/CreateBillingAgreement.md +16 -0
- package/docs/CreateBundledDecisionManagerCaseRequest.md +1 -0
- package/docs/IntimateBillingAgreement.md +12 -0
- package/docs/InvoiceSettingsApi.md +2 -2
- package/docs/InvoicesApi.md +6 -6
- package/docs/ModifyBillingAgreement.md +16 -0
- package/docs/PlansApi.md +12 -20
- package/docs/PtsV2CreditsPost201Response1.md +12 -0
- package/docs/PtsV2CreditsPost201Response1InstallmentInformation.md +8 -0
- package/docs/PtsV2CreditsPost201Response1ProcessorInformation.md +9 -0
- package/docs/PtsV2PaymentsPost201Response.md +1 -0
- package/docs/PtsV2PaymentsPost201ResponseEmbeddedActions.md +12 -0
- package/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE.md +10 -0
- package/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.md +10 -0
- package/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION.md +10 -0
- package/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING.md +10 -0
- package/docs/Ptsv2billingagreementsAggregatorInformation.md +9 -0
- package/docs/Ptsv2billingagreementsConsumerAuthenticationInformation.md +11 -0
- package/docs/Ptsv2billingagreementsDeviceInformation.md +10 -0
- package/docs/Ptsv2billingagreementsInstallmentInformation.md +16 -0
- package/docs/Ptsv2billingagreementsMerchantInformation.md +11 -0
- package/docs/Ptsv2billingagreementsMerchantInformationMerchantDescriptor.md +11 -0
- package/docs/Ptsv2billingagreementsOrderInformation.md +9 -0
- package/docs/Ptsv2billingagreementsOrderInformationBillTo.md +20 -0
- package/docs/Ptsv2billingagreementsPaymentInformation.md +9 -0
- package/docs/Ptsv2billingagreementsPaymentInformationCard.md +12 -0
- package/docs/Ptsv2billingagreementsPaymentInformationTokenizedCard.md +13 -0
- package/docs/Ptsv2billingagreementsProcessingInformation.md +9 -0
- package/docs/Ptsv2paymentsOrderInformation.md +1 -0
- package/docs/Ptsv2paymentsProcessingInformation.md +1 -1
- package/docs/Ptsv2paymentsRecipientInformation.md +1 -0
- package/docs/Riskv1authenticationsetupsTokenInformation.md +1 -0
- package/docs/Riskv1decisionsOrderInformation.md +1 -0
- package/docs/Riskv1decisionsTokenInformation.md +8 -0
- package/docs/SubscriptionsApi.md +14 -26
- package/docs/TssV2TransactionsGet200Response.md +1 -0
- package/docs/TssV2TransactionsPost201Response.md +0 -1
- package/docs/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.md +2 -0
- package/docs/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md +8 -0
- package/docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md +2 -0
- package/docs/ValidateRequest.md +1 -0
- package/package.json +1 -1
- package/src/ApiClient.js +3 -1
- package/src/api/BillingAgreementsApi.js +203 -0
- package/src/api/InvoiceSettingsApi.js +2 -2
- package/src/api/InvoicesApi.js +6 -6
- package/src/api/PlansApi.js +18 -18
- package/src/api/SubscriptionsApi.js +23 -23
- package/src/index.js +133 -3
- package/src/model/CreateBillingAgreement.js +145 -0
- package/src/model/CreateBundledDecisionManagerCaseRequest.js +12 -4
- package/src/model/IntimateBillingAgreement.js +113 -0
- package/src/model/ModifyBillingAgreement.js +145 -0
- package/src/model/PtsV2CreditsPost201Response1.js +116 -0
- package/src/model/PtsV2CreditsPost201Response1InstallmentInformation.js +82 -0
- package/src/model/PtsV2CreditsPost201Response1ProcessorInformation.js +91 -0
- package/src/model/PtsV2PaymentsPost201Response.js +12 -4
- package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActions.js +114 -0
- package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE.js +100 -0
- package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.js +100 -0
- package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION.js +100 -0
- package/src/model/PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING.js +100 -0
- package/src/model/Ptsv2billingagreementsAggregatorInformation.js +90 -0
- package/src/model/Ptsv2billingagreementsConsumerAuthenticationInformation.js +109 -0
- package/src/model/Ptsv2billingagreementsDeviceInformation.js +100 -0
- package/src/model/Ptsv2billingagreementsInstallmentInformation.js +154 -0
- package/src/model/Ptsv2billingagreementsMerchantInformation.js +108 -0
- package/src/model/Ptsv2billingagreementsMerchantInformationMerchantDescriptor.js +109 -0
- package/src/model/Ptsv2billingagreementsOrderInformation.js +89 -0
- package/src/model/Ptsv2billingagreementsOrderInformationBillTo.js +190 -0
- package/src/model/Ptsv2billingagreementsPaymentInformation.js +89 -0
- package/src/model/Ptsv2billingagreementsPaymentInformationCard.js +118 -0
- package/src/model/Ptsv2billingagreementsPaymentInformationTokenizedCard.js +127 -0
- package/src/model/Ptsv2billingagreementsProcessingInformation.js +91 -0
- package/src/model/Ptsv2paymentsOrderInformation.js +9 -0
- package/src/model/Ptsv2paymentsProcessingInformation.js +1 -1
- package/src/model/Ptsv2paymentsRecipientInformation.js +9 -0
- package/src/model/Riskv1authenticationsetupsTokenInformation.js +9 -0
- package/src/model/Riskv1decisionsOrderInformation.js +9 -0
- package/src/model/Riskv1decisionsTokenInformation.js +82 -0
- package/src/model/TssV2TransactionsGet200Response.js +9 -0
- package/src/model/TssV2TransactionsPost201Response.js +0 -9
- package/src/model/TssV2TransactionsPost201ResponseEmbeddedApplicationInformationApplications.js +18 -0
- package/src/model/TssV2TransactionsPost201ResponseEmbeddedErrorInformation.js +82 -0
- package/src/model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.js +21 -4
- package/src/model/ValidateRequest.js +12 -4
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# CyberSource.BillingAgreementsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://apitest.cybersource.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**billingAgreementsDeRegistration**](BillingAgreementsApi.md#billingAgreementsDeRegistration) | **PATCH** /pts/v2/billing-agreements/{id} | Standing Instruction Cancellation or Modification
|
|
8
|
+
[**billingAgreementsIntimation**](BillingAgreementsApi.md#billingAgreementsIntimation) | **POST** /pts/v2/billing-agreements/{id}/intimations | Standing Instruction intimation
|
|
9
|
+
[**billingAgreementsRegistration**](BillingAgreementsApi.md#billingAgreementsRegistration) | **POST** /pts/v2/billing-agreements | Standing Instruction completion registration
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<a name="billingAgreementsDeRegistration"></a>
|
|
13
|
+
# **billingAgreementsDeRegistration**
|
|
14
|
+
> PtsV2CreditsPost201Response1 billingAgreementsDeRegistration(modifyBillingAgreement, id)
|
|
15
|
+
|
|
16
|
+
Standing Instruction Cancellation or Modification
|
|
17
|
+
|
|
18
|
+
Standing Instruction with or without Token
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
```javascript
|
|
22
|
+
var CyberSource = require('CyberSource');
|
|
23
|
+
|
|
24
|
+
var apiInstance = new CyberSource.BillingAgreementsApi();
|
|
25
|
+
|
|
26
|
+
var modifyBillingAgreement = new CyberSource.ModifyBillingAgreement(); // ModifyBillingAgreement |
|
|
27
|
+
|
|
28
|
+
var id = "id_example"; // String | ID for de-registration or cancellation of Billing Agreement
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
var callback = function(error, data, response) {
|
|
32
|
+
if (error) {
|
|
33
|
+
console.error(error);
|
|
34
|
+
} else {
|
|
35
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
apiInstance.billingAgreementsDeRegistration(modifyBillingAgreement, id, callback);
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Parameters
|
|
42
|
+
|
|
43
|
+
Name | Type | Description | Notes
|
|
44
|
+
------------- | ------------- | ------------- | -------------
|
|
45
|
+
**modifyBillingAgreement** | [**ModifyBillingAgreement**](ModifyBillingAgreement.md)| |
|
|
46
|
+
**id** | **String**| ID for de-registration or cancellation of Billing Agreement |
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md)
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
No authorization required
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: application/json;charset=utf-8
|
|
59
|
+
- **Accept**: application/hal+json;charset=utf-8
|
|
60
|
+
|
|
61
|
+
<a name="billingAgreementsIntimation"></a>
|
|
62
|
+
# **billingAgreementsIntimation**
|
|
63
|
+
> PtsV2CreditsPost201Response1 billingAgreementsIntimation(intimateBillingAgreement, id)
|
|
64
|
+
|
|
65
|
+
Standing Instruction intimation
|
|
66
|
+
|
|
67
|
+
Standing Instruction with or without Token.
|
|
68
|
+
|
|
69
|
+
### Example
|
|
70
|
+
```javascript
|
|
71
|
+
var CyberSource = require('CyberSource');
|
|
72
|
+
|
|
73
|
+
var apiInstance = new CyberSource.BillingAgreementsApi();
|
|
74
|
+
|
|
75
|
+
var intimateBillingAgreement = new CyberSource.IntimateBillingAgreement(); // IntimateBillingAgreement |
|
|
76
|
+
|
|
77
|
+
var id = "id_example"; // String | ID for intimation of Billing Agreement
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
var callback = function(error, data, response) {
|
|
81
|
+
if (error) {
|
|
82
|
+
console.error(error);
|
|
83
|
+
} else {
|
|
84
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
85
|
+
}
|
|
86
|
+
};
|
|
87
|
+
apiInstance.billingAgreementsIntimation(intimateBillingAgreement, id, callback);
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Parameters
|
|
91
|
+
|
|
92
|
+
Name | Type | Description | Notes
|
|
93
|
+
------------- | ------------- | ------------- | -------------
|
|
94
|
+
**intimateBillingAgreement** | [**IntimateBillingAgreement**](IntimateBillingAgreement.md)| |
|
|
95
|
+
**id** | **String**| ID for intimation of Billing Agreement |
|
|
96
|
+
|
|
97
|
+
### Return type
|
|
98
|
+
|
|
99
|
+
[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md)
|
|
100
|
+
|
|
101
|
+
### Authorization
|
|
102
|
+
|
|
103
|
+
No authorization required
|
|
104
|
+
|
|
105
|
+
### HTTP request headers
|
|
106
|
+
|
|
107
|
+
- **Content-Type**: application/json;charset=utf-8
|
|
108
|
+
- **Accept**: application/hal+json;charset=utf-8
|
|
109
|
+
|
|
110
|
+
<a name="billingAgreementsRegistration"></a>
|
|
111
|
+
# **billingAgreementsRegistration**
|
|
112
|
+
> PtsV2CreditsPost201Response1 billingAgreementsRegistration(createBillingAgreement)
|
|
113
|
+
|
|
114
|
+
Standing Instruction completion registration
|
|
115
|
+
|
|
116
|
+
Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed
|
|
117
|
+
|
|
118
|
+
### Example
|
|
119
|
+
```javascript
|
|
120
|
+
var CyberSource = require('CyberSource');
|
|
121
|
+
|
|
122
|
+
var apiInstance = new CyberSource.BillingAgreementsApi();
|
|
123
|
+
|
|
124
|
+
var createBillingAgreement = new CyberSource.CreateBillingAgreement(); // CreateBillingAgreement |
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
var callback = function(error, data, response) {
|
|
128
|
+
if (error) {
|
|
129
|
+
console.error(error);
|
|
130
|
+
} else {
|
|
131
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
132
|
+
}
|
|
133
|
+
};
|
|
134
|
+
apiInstance.billingAgreementsRegistration(createBillingAgreement, callback);
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Parameters
|
|
138
|
+
|
|
139
|
+
Name | Type | Description | Notes
|
|
140
|
+
------------- | ------------- | ------------- | -------------
|
|
141
|
+
**createBillingAgreement** | [**CreateBillingAgreement**](CreateBillingAgreement.md)| |
|
|
142
|
+
|
|
143
|
+
### Return type
|
|
144
|
+
|
|
145
|
+
[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md)
|
|
146
|
+
|
|
147
|
+
### Authorization
|
|
148
|
+
|
|
149
|
+
No authorization required
|
|
150
|
+
|
|
151
|
+
### HTTP request headers
|
|
152
|
+
|
|
153
|
+
- **Content-Type**: application/json;charset=utf-8
|
|
154
|
+
- **Accept**: application/hal+json;charset=utf-8
|
|
155
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CyberSource.CreateBillingAgreement
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**clientReferenceInformation** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional]
|
|
7
|
+
**aggregatorInformation** | [**Ptsv2billingagreementsAggregatorInformation**](Ptsv2billingagreementsAggregatorInformation.md) | | [optional]
|
|
8
|
+
**consumerAuthenticationInformation** | [**Ptsv2billingagreementsConsumerAuthenticationInformation**](Ptsv2billingagreementsConsumerAuthenticationInformation.md) | | [optional]
|
|
9
|
+
**deviceInformation** | [**Ptsv2billingagreementsDeviceInformation**](Ptsv2billingagreementsDeviceInformation.md) | | [optional]
|
|
10
|
+
**installmentInformation** | [**Ptsv2billingagreementsInstallmentInformation**](Ptsv2billingagreementsInstallmentInformation.md) | | [optional]
|
|
11
|
+
**merchantInformation** | [**Ptsv2billingagreementsMerchantInformation**](Ptsv2billingagreementsMerchantInformation.md) | | [optional]
|
|
12
|
+
**orderInformation** | [**Ptsv2billingagreementsOrderInformation**](Ptsv2billingagreementsOrderInformation.md) | | [optional]
|
|
13
|
+
**paymentInformation** | [**Ptsv2billingagreementsPaymentInformation**](Ptsv2billingagreementsPaymentInformation.md) | | [optional]
|
|
14
|
+
**processingInformation** | [**Ptsv2billingagreementsProcessingInformation**](Ptsv2billingagreementsProcessingInformation.md) | | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -18,5 +18,6 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**recurringPaymentInformation** | [**Ptsv2paymentsRecurringPaymentInformation**](Ptsv2paymentsRecurringPaymentInformation.md) | | [optional]
|
|
19
19
|
**consumerAuthenticationInformation** | [**Riskv1decisionsConsumerAuthenticationInformation**](Riskv1decisionsConsumerAuthenticationInformation.md) | | [optional]
|
|
20
20
|
**watchlistScreeningInformation** | [**Ptsv2paymentsWatchlistScreeningInformation**](Ptsv2paymentsWatchlistScreeningInformation.md) | | [optional]
|
|
21
|
+
**tokenInformation** | [**Riskv1decisionsTokenInformation**](Riskv1decisionsTokenInformation.md) | | [optional]
|
|
21
22
|
|
|
22
23
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CyberSource.IntimateBillingAgreement
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**clientReferenceInformation** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional]
|
|
7
|
+
**installmentInformation** | [**Ptsv2billingagreementsInstallmentInformation**](Ptsv2billingagreementsInstallmentInformation.md) | | [optional]
|
|
8
|
+
**merchantInformation** | [**Ptsv2billingagreementsMerchantInformation**](Ptsv2billingagreementsMerchantInformation.md) | | [optional]
|
|
9
|
+
**orderInformation** | [**Ptsv2billingagreementsOrderInformation**](Ptsv2billingagreementsOrderInformation.md) | | [optional]
|
|
10
|
+
**paymentInformation** | [**Ptsv2billingagreementsPaymentInformation**](Ptsv2billingagreementsPaymentInformation.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -46,7 +46,7 @@ No authorization required
|
|
|
46
46
|
### HTTP request headers
|
|
47
47
|
|
|
48
48
|
- **Content-Type**: application/json;charset=utf-8
|
|
49
|
-
- **Accept**: application/json;charset=utf-8
|
|
49
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
50
50
|
|
|
51
51
|
<a name="updateInvoiceSettings"></a>
|
|
52
52
|
# **updateInvoiceSettings**
|
|
@@ -92,5 +92,5 @@ No authorization required
|
|
|
92
92
|
### HTTP request headers
|
|
93
93
|
|
|
94
94
|
- **Content-Type**: application/json;charset=utf-8
|
|
95
|
-
- **Accept**: application/json;charset=utf-8
|
|
95
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
96
96
|
|
package/docs/InvoicesApi.md
CHANGED
|
@@ -56,7 +56,7 @@ No authorization required
|
|
|
56
56
|
### HTTP request headers
|
|
57
57
|
|
|
58
58
|
- **Content-Type**: application/json;charset=utf-8
|
|
59
|
-
- **Accept**: application/json;charset=utf-8
|
|
59
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
60
60
|
|
|
61
61
|
<a name="getAllInvoices"></a>
|
|
62
62
|
# **getAllInvoices**
|
|
@@ -109,7 +109,7 @@ No authorization required
|
|
|
109
109
|
### HTTP request headers
|
|
110
110
|
|
|
111
111
|
- **Content-Type**: application/json;charset=utf-8
|
|
112
|
-
- **Accept**: application/json;charset=utf-8
|
|
112
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
113
113
|
|
|
114
114
|
<a name="getInvoice"></a>
|
|
115
115
|
# **getInvoice**
|
|
@@ -155,7 +155,7 @@ No authorization required
|
|
|
155
155
|
### HTTP request headers
|
|
156
156
|
|
|
157
157
|
- **Content-Type**: application/json;charset=utf-8
|
|
158
|
-
- **Accept**: application/json;charset=utf-8
|
|
158
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
159
159
|
|
|
160
160
|
<a name="performCancelAction"></a>
|
|
161
161
|
# **performCancelAction**
|
|
@@ -201,7 +201,7 @@ No authorization required
|
|
|
201
201
|
### HTTP request headers
|
|
202
202
|
|
|
203
203
|
- **Content-Type**: application/json;charset=utf-8
|
|
204
|
-
- **Accept**: application/json;charset=utf-8
|
|
204
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
205
205
|
|
|
206
206
|
<a name="performSendAction"></a>
|
|
207
207
|
# **performSendAction**
|
|
@@ -247,7 +247,7 @@ No authorization required
|
|
|
247
247
|
### HTTP request headers
|
|
248
248
|
|
|
249
249
|
- **Content-Type**: application/json;charset=utf-8
|
|
250
|
-
- **Accept**: application/json;charset=utf-8
|
|
250
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
251
251
|
|
|
252
252
|
<a name="updateInvoice"></a>
|
|
253
253
|
# **updateInvoice**
|
|
@@ -296,5 +296,5 @@ No authorization required
|
|
|
296
296
|
### HTTP request headers
|
|
297
297
|
|
|
298
298
|
- **Content-Type**: application/json;charset=utf-8
|
|
299
|
-
- **Accept**: application/json;charset=utf-8
|
|
299
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
300
300
|
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CyberSource.ModifyBillingAgreement
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**clientReferenceInformation** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional]
|
|
7
|
+
**aggregatorInformation** | [**Ptsv2billingagreementsAggregatorInformation**](Ptsv2billingagreementsAggregatorInformation.md) | | [optional]
|
|
8
|
+
**consumerAuthenticationInformation** | [**Ptsv2billingagreementsConsumerAuthenticationInformation**](Ptsv2billingagreementsConsumerAuthenticationInformation.md) | | [optional]
|
|
9
|
+
**deviceInformation** | [**Ptsv2billingagreementsDeviceInformation**](Ptsv2billingagreementsDeviceInformation.md) | | [optional]
|
|
10
|
+
**installmentInformation** | [**Ptsv2billingagreementsInstallmentInformation**](Ptsv2billingagreementsInstallmentInformation.md) | | [optional]
|
|
11
|
+
**merchantInformation** | [**Ptsv2billingagreementsMerchantInformation**](Ptsv2billingagreementsMerchantInformation.md) | | [optional]
|
|
12
|
+
**orderInformation** | [**Ptsv2billingagreementsOrderInformation**](Ptsv2billingagreementsOrderInformation.md) | | [optional]
|
|
13
|
+
**paymentInformation** | [**Ptsv2billingagreementsPaymentInformation**](Ptsv2billingagreementsPaymentInformation.md) | | [optional]
|
|
14
|
+
**processingInformation** | [**Ptsv2billingagreementsProcessingInformation**](Ptsv2billingagreementsProcessingInformation.md) | | [optional]
|
|
15
|
+
|
|
16
|
+
|
package/docs/PlansApi.md
CHANGED
|
@@ -16,7 +16,7 @@ Method | HTTP request | Description
|
|
|
16
16
|
|
|
17
17
|
<a name="activatePlan"></a>
|
|
18
18
|
# **activatePlan**
|
|
19
|
-
> InlineResponse2004 activatePlan(id
|
|
19
|
+
> InlineResponse2004 activatePlan(id)
|
|
20
20
|
|
|
21
21
|
Activate a Plan
|
|
22
22
|
|
|
@@ -30,9 +30,6 @@ var apiInstance = new CyberSource.PlansApi();
|
|
|
30
30
|
|
|
31
31
|
var id = "id_example"; // String | Plan Id
|
|
32
32
|
|
|
33
|
-
var opts = {
|
|
34
|
-
'activatePlanRequest': null // Object |
|
|
35
|
-
};
|
|
36
33
|
|
|
37
34
|
var callback = function(error, data, response) {
|
|
38
35
|
if (error) {
|
|
@@ -41,7 +38,7 @@ var callback = function(error, data, response) {
|
|
|
41
38
|
console.log('API called successfully. Returned data: ' + data);
|
|
42
39
|
}
|
|
43
40
|
};
|
|
44
|
-
apiInstance.activatePlan(id,
|
|
41
|
+
apiInstance.activatePlan(id, callback);
|
|
45
42
|
```
|
|
46
43
|
|
|
47
44
|
### Parameters
|
|
@@ -49,7 +46,6 @@ apiInstance.activatePlan(id, opts, callback);
|
|
|
49
46
|
Name | Type | Description | Notes
|
|
50
47
|
------------- | ------------- | ------------- | -------------
|
|
51
48
|
**id** | **String**| Plan Id |
|
|
52
|
-
**activatePlanRequest** | **Object**| | [optional]
|
|
53
49
|
|
|
54
50
|
### Return type
|
|
55
51
|
|
|
@@ -62,7 +58,7 @@ No authorization required
|
|
|
62
58
|
### HTTP request headers
|
|
63
59
|
|
|
64
60
|
- **Content-Type**: application/json;charset=utf-8
|
|
65
|
-
- **Accept**: application/hal+json;charset=utf-8
|
|
61
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
66
62
|
|
|
67
63
|
<a name="createPlan"></a>
|
|
68
64
|
# **createPlan**
|
|
@@ -108,11 +104,11 @@ No authorization required
|
|
|
108
104
|
### HTTP request headers
|
|
109
105
|
|
|
110
106
|
- **Content-Type**: application/json;charset=utf-8
|
|
111
|
-
- **Accept**: application/hal+json;charset=utf-8
|
|
107
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
112
108
|
|
|
113
109
|
<a name="deactivatePlan"></a>
|
|
114
110
|
# **deactivatePlan**
|
|
115
|
-
> InlineResponse2004 deactivatePlan(id
|
|
111
|
+
> InlineResponse2004 deactivatePlan(id)
|
|
116
112
|
|
|
117
113
|
Deactivate a Plan
|
|
118
114
|
|
|
@@ -126,9 +122,6 @@ var apiInstance = new CyberSource.PlansApi();
|
|
|
126
122
|
|
|
127
123
|
var id = "id_example"; // String | Plan Id
|
|
128
124
|
|
|
129
|
-
var opts = {
|
|
130
|
-
'deactivatePlanRequest': null // Object |
|
|
131
|
-
};
|
|
132
125
|
|
|
133
126
|
var callback = function(error, data, response) {
|
|
134
127
|
if (error) {
|
|
@@ -137,7 +130,7 @@ var callback = function(error, data, response) {
|
|
|
137
130
|
console.log('API called successfully. Returned data: ' + data);
|
|
138
131
|
}
|
|
139
132
|
};
|
|
140
|
-
apiInstance.deactivatePlan(id,
|
|
133
|
+
apiInstance.deactivatePlan(id, callback);
|
|
141
134
|
```
|
|
142
135
|
|
|
143
136
|
### Parameters
|
|
@@ -145,7 +138,6 @@ apiInstance.deactivatePlan(id, opts, callback);
|
|
|
145
138
|
Name | Type | Description | Notes
|
|
146
139
|
------------- | ------------- | ------------- | -------------
|
|
147
140
|
**id** | **String**| Plan Id |
|
|
148
|
-
**deactivatePlanRequest** | **Object**| | [optional]
|
|
149
141
|
|
|
150
142
|
### Return type
|
|
151
143
|
|
|
@@ -158,7 +150,7 @@ No authorization required
|
|
|
158
150
|
### HTTP request headers
|
|
159
151
|
|
|
160
152
|
- **Content-Type**: application/json;charset=utf-8
|
|
161
|
-
- **Accept**: application/hal+json;charset=utf-8
|
|
153
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
162
154
|
|
|
163
155
|
<a name="deletePlan"></a>
|
|
164
156
|
# **deletePlan**
|
|
@@ -204,7 +196,7 @@ No authorization required
|
|
|
204
196
|
### HTTP request headers
|
|
205
197
|
|
|
206
198
|
- **Content-Type**: application/json;charset=utf-8
|
|
207
|
-
- **Accept**: application/hal+json;charset=utf-8
|
|
199
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
208
200
|
|
|
209
201
|
<a name="getPlan"></a>
|
|
210
202
|
# **getPlan**
|
|
@@ -250,7 +242,7 @@ No authorization required
|
|
|
250
242
|
### HTTP request headers
|
|
251
243
|
|
|
252
244
|
- **Content-Type**: application/json;charset=utf-8
|
|
253
|
-
- **Accept**: application/hal+json;charset=utf-8
|
|
245
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
254
246
|
|
|
255
247
|
<a name="getPlanCode"></a>
|
|
256
248
|
# **getPlanCode**
|
|
@@ -290,7 +282,7 @@ No authorization required
|
|
|
290
282
|
### HTTP request headers
|
|
291
283
|
|
|
292
284
|
- **Content-Type**: application/json;charset=utf-8
|
|
293
|
-
- **Accept**: application/hal+json;charset=utf-8
|
|
285
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
294
286
|
|
|
295
287
|
<a name="getPlans"></a>
|
|
296
288
|
# **getPlans**
|
|
@@ -345,7 +337,7 @@ No authorization required
|
|
|
345
337
|
### HTTP request headers
|
|
346
338
|
|
|
347
339
|
- **Content-Type**: application/json;charset=utf-8
|
|
348
|
-
- **Accept**: application/hal+json;charset=utf-8
|
|
340
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
349
341
|
|
|
350
342
|
<a name="updatePlan"></a>
|
|
351
343
|
# **updatePlan**
|
|
@@ -394,5 +386,5 @@ No authorization required
|
|
|
394
386
|
### HTTP request headers
|
|
395
387
|
|
|
396
388
|
- **Content-Type**: application/json;charset=utf-8
|
|
397
|
-
- **Accept**: application/hal+json;charset=utf-8
|
|
389
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
|
|
398
390
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CyberSource.PtsV2CreditsPost201Response1
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
|
|
7
|
+
**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional]
|
|
8
|
+
**status** | **String** | The status of the submitted transaction. | [optional]
|
|
9
|
+
**processorInformation** | [**PtsV2CreditsPost201Response1ProcessorInformation**](PtsV2CreditsPost201Response1ProcessorInformation.md) | | [optional]
|
|
10
|
+
**installmentInformation** | [**PtsV2CreditsPost201Response1InstallmentInformation**](PtsV2CreditsPost201Response1InstallmentInformation.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CyberSource.PtsV2CreditsPost201Response1ProcessorInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**approvalCode** | **String** | Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. | [optional]
|
|
7
|
+
**responseCode** | **String** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -23,6 +23,7 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**buyerInformation** | [**PtsV2PaymentsPost201ResponseBuyerInformation**](PtsV2PaymentsPost201ResponseBuyerInformation.md) | | [optional]
|
|
24
24
|
**riskInformation** | [**PtsV2PaymentsPost201ResponseRiskInformation**](PtsV2PaymentsPost201ResponseRiskInformation.md) | | [optional]
|
|
25
25
|
**consumerAuthenticationInformation** | [**PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation**](PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md) | | [optional]
|
|
26
|
+
**embeddedActions** | [**PtsV2PaymentsPost201ResponseEmbeddedActions**](PtsV2PaymentsPost201ResponseEmbeddedActions.md) | | [optional]
|
|
26
27
|
**watchlistScreeningInformation** | [**PtsV2PaymentsPost201ResponseWatchlistScreeningInformation**](PtsV2PaymentsPost201ResponseWatchlistScreeningInformation.md) | | [optional]
|
|
27
28
|
|
|
28
29
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CyberSource.PtsV2PaymentsPost201ResponseEmbeddedActions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**CAPTURE** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE**](PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE.md) | | [optional]
|
|
7
|
+
**DECISION** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION**](PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION.md) | | [optional]
|
|
8
|
+
**CONSUMER_AUTHENTICATION** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION**](PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.md) | | [optional]
|
|
9
|
+
**VALIDATE_CONSUMER_AUTHENTICATION** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION**](PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.md) | | [optional]
|
|
10
|
+
**WATCHLIST_SCREENING** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING**](PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CyberSource.PtsV2PaymentsPost201ResponseEmbeddedActionsCAPTURE
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**status** | **String** | The status of the submitted transaction. Possible values: - PENDING | [optional]
|
|
7
|
+
**reason** | **String** | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_MERCHANT_CONFIGURATION - EXCEEDS_AUTH_AMOUNT - AUTH_ALREADY_REVERSED - TRANSACTION_ALREADY_SETTLED - INVALID_AMOUNT - MISSING_AUTH - TRANSACTION_ALREADY_REVERSED_OR_SETTLED - NOT_SUPPORTED | [optional]
|
|
8
|
+
**message** | **String** | The detail message related to the status and reason listed above. | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CyberSource.PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**status** | **String** | The status for payerAuthentication 201 enroll and validate calls. Possible values are: - `AUTHENTICATION_SUCCESSFUL` - `PENDING_AUTHENTICATION` - `INVALID_REQUEST` - `AUTHENTICATION_FAILED` | [optional]
|
|
7
|
+
**reason** | **String** | The reason of the status. Possible values are: - `INVALID_MERCHANT_CONFIGURATION` - `CONSUMER_AUTHENTICATION_REQUIRED` - `CONSUMER_AUTHENTICATION_FAILED` - `AUTHENTICATION_FAILED` | [optional]
|
|
8
|
+
**message** | **String** | The message describing the reason of the status. Value is: - Encountered a Payer Authentication problem. Payer could not be authenticated. | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CyberSource.PtsV2PaymentsPost201ResponseEmbeddedActionsDECISION
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**status** | **String** | The status of the submitted transaction. Possible values: - `ACCEPTED` - `REJECTED` - `PENDING_REVIEW` - `DECLINED` - `PENDING_AUTHENTICATION` - `INVALID_REQUEST` - `AUTHENTICATION_FAILED` - `CHALLENGE` | [optional]
|
|
7
|
+
**reason** | **String** | The reason of the status. Possible values: - `EXPIRED_CARD` - `SCORE_EXCEEDS_THRESHOLD` - `DECISION_PROFILE_REVIEW` - `DECISION_PROFILE_REJECT` - `CONSUMER_AUTHENTICATION_REQUIRED` - `INVALID_MERCHANT_CONFIGURATION` - `CONSUMER_AUTHENTICATION_FAILED` - `DECISION_PROFILE_CHALLENGE` - `CUSTOMER_WATCHLIST_MATCH` - `ADDRESS_COUNTRY_WATCHLIST_MATCH` - `EMAIL_COUNTRY_WATCHLIST_MATCH` - `IP_COUNTRY_WATCHLIST_MATCH` | [optional]
|
|
8
|
+
**message** | **String** | The detail message related to the status and reason listed above. | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CyberSource.PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**status** | **String** | The status for the call can be: - COMPLETED - INVALID_REQUEST - DECLINED | [optional]
|
|
7
|
+
**reason** | **String** | The reason of the status. Value can be - `CUSTOMER_WATCHLIST_MATCH` - `ADDRESS_COUNTRY_WATCHLIST_MATCH` - `EMAIL_COUNTRY_WATCHLIST_MATCH` - `IP_COUNTRY_WATCHLIST_MATCH` - `INVALID_MERCHANT_CONFIGURATION` | [optional]
|
|
8
|
+
**message** | **String** | The message describing the reason of the status. Value can be - The customer matched the Denied Parties List - The Export bill_country/ship_country match - Export email_country match - Export hostname_country/ip_country match | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsAggregatorInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ #### CyberSource through VisaNet With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
|
|
7
|
+
**subMerchant** | [**Ptsv2paymentsAggregatorInformationSubMerchant**](Ptsv2paymentsAggregatorInformationSubMerchant.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsConsumerAuthenticationInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**authenticationTransactionContextId** | **String** | Payer authentication transaction identifier passed to link the validation and authorization calls. | [optional]
|
|
7
|
+
**cavv** | **String** | Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after the customer is authenticated. The value is in base64. When you request the card authorization service, CyberSource automatically converts the value, not the field name, to the format required by your payment processor. | [optional]
|
|
8
|
+
**transactionToken** | **String** | Web based token used to authenticate consumer with Rupay authentication provider. | [optional]
|
|
9
|
+
**xid** | **String** | Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the **ecommerceIndicator**`=spa`) | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsDeviceInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**httpAcceptBrowserValue** | **String** | Value of the Accept header sent by the customer’s web browser. **Note** If the customer’s browser provides a value, you must include it in your request. | [optional]
|
|
7
|
+
**ipAddress** | **String** | IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field. | [optional]
|
|
8
|
+
**userAgentBrowserValue** | **String** | Value of the User-Agent header sent by the customer’s web browser. Note If the customer’s browser provides a value, you must include it in your request. | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsInstallmentInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**alertPreference** | **String** | Applicable only for SI. Required in case the authentication is initiated for SI registration. Valid Values: - `SMS` - `EMAIL` - `BOTH` | [optional]
|
|
7
|
+
**firstInstallmentDate** | **String** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional]
|
|
8
|
+
**identifier** | **String** | Standing Instruction/Installment identifier. | [optional]
|
|
9
|
+
**lastInstallmentDate** | **String** | End date of the SI transactions. Cannot be later than card expiry date. Ideally this can be set to expiry date. Required in case the authentication is initiated for SI registration. | [optional]
|
|
10
|
+
**maxAmount** | **String** | Maximum Amount for which SI can be initiated. Required in case the authentication is initiated for SI registration. | [optional]
|
|
11
|
+
**minAmount** | **String** | Minimum Amount for which SI can be initiated. Required in case the authentication is initiated for SI registration. | [optional]
|
|
12
|
+
**paymentType** | **String** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional]
|
|
13
|
+
**preferredDay** | **String** | Preferred date for initiating the SI transaction every month. This field need not be sent in case the SI has to be initiated as and when required, e.g., topping up the wallet, etc. | [optional]
|
|
14
|
+
**sequence** | **Number** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * 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 card companies. | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsMerchantInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**merchantDescriptor** | [**Ptsv2billingagreementsMerchantInformationMerchantDescriptor**](Ptsv2billingagreementsMerchantInformationMerchantDescriptor.md) | | [optional]
|
|
7
|
+
**categoryCode** | **Number** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional]
|
|
8
|
+
**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]
|
|
9
|
+
**transactionLocalDateTime** | **String** | Date and time at your physical location. Format: `YYYYMMDDhhmmss`, where: - `YYYY` = year - `MM` = month - `DD` = day - `hh` = hour - `mm` = minutes - `ss` = seconds #### Used by **Authorization** Required for these processors: - American Express Direct - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX Optional for all other processors. | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsMerchantInformationMerchantDescriptor
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**postalCode** | **String** | Merchant's postal code. #### PIN debit Postal code for your business location. This value might be displayed on the cardholder’s statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: `12345-6789` If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: `A1B 2C3` When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. **Important** Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your account or you can include this field in your request. Optional field for PIN debit credit or PIN debit purchase. | [optional]
|
|
7
|
+
**contact** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) | [optional]
|
|
8
|
+
**locality** | **String** | Merchant's City. #### PIN debit City for your business location. 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. Optional field for PIN debit credit or PIN debit purchase requests. | [optional]
|
|
9
|
+
**name** | **String** | Your merchant name. **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder’s statement. When you include more than one consecutive space, extra spaces are removed. 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. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder’s statement. When you include more than one consecutive space, extra spaces are removed. **Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field. **Important** This value must consist of English characters. Required for captures and credits. | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsOrderInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**amountDetails** | [**Ptsv2paymentsidreversalsReversalInformationAmountDetails**](Ptsv2paymentsidreversalsReversalInformationAmountDetails.md) | | [optional]
|
|
7
|
+
**billTo** | [**Ptsv2billingagreementsOrderInformationBillTo**](Ptsv2billingagreementsOrderInformationBillTo.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|