cybersource-rest-client 0.0.46 → 0.0.48
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/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.md +3 -1
- package/docs/Invoicingv2invoiceSettingsInvoiceSettingsInformation.md +2 -0
- package/docs/Invoicingv2invoicesCustomerInformation.md +1 -0
- package/docs/Invoicingv2invoicesCustomerInformationCompany.md +8 -0
- package/docs/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md +1 -0
- package/docs/Invoicingv2invoicesOrderInformationLineItems.md +5 -0
- package/docs/PlansApi.md +12 -20
- 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/PtsV2PaymentsPost201ResponseProcessorInformation.md +1 -0
- package/docs/PtsV2PaymentsRefundPost201ResponseProcessorInformation.md +1 -0
- package/docs/PtsV2PayoutsPost201ResponseRecipientInformationCard.md +1 -1
- package/docs/Ptsv2paymentsOrderInformationAmountDetails.md +1 -1
- package/docs/Ptsv2paymentsPaymentInformationPaymentType.md +1 -0
- package/docs/Ptsv2paymentsProcessingInformation.md +2 -1
- package/docs/Ptsv2paymentsRecipientInformation.md +1 -0
- package/docs/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md +1 -1
- package/docs/SubscriptionsApi.md +14 -26
- package/docs/TssV2TransactionsGet200Response.md +2 -0
- package/docs/TssV2TransactionsGet200ResponsePaymentInformation.md +4 -0
- package/docs/TssV2TransactionsGet200ResponsePaymentInformationBrands.md +9 -0
- package/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md +2 -0
- package/docs/TssV2TransactionsGet200ResponsePaymentInformationFeatures.md +14 -0
- package/docs/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md +11 -0
- package/docs/TssV2TransactionsGet200ResponsePaymentInformationNetwork.md +8 -0
- package/docs/TssV2TransactionsGet200ResponsePayoutOptions.md +8 -0
- package/docs/TssV2TransactionsGet200ResponseProcessingInformation.md +1 -0
- package/docs/TssV2TransactionsGet200ResponseTokenInformation.md +2 -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/package.json +1 -1
- package/src/api/PlansApi.js +18 -18
- package/src/api/SubscriptionsApi.js +23 -23
- package/src/index.js +63 -3
- package/src/model/InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformation.js +24 -4
- package/src/model/Invoicingv2invoiceSettingsInvoiceSettingsInformation.js +19 -0
- package/src/model/Invoicingv2invoicesCustomerInformation.js +12 -4
- package/src/model/Invoicingv2invoicesCustomerInformationCompany.js +82 -0
- package/src/model/Invoicingv2invoicesOrderInformationAmountDetailsFreight.js +9 -0
- package/src/model/Invoicingv2invoicesOrderInformationLineItems.js +45 -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/PtsV2PaymentsPost201ResponseProcessorInformation.js +9 -0
- package/src/model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.js +9 -0
- package/src/model/PtsV2PayoutsPost201ResponseRecipientInformationCard.js +1 -1
- package/src/model/Ptsv2paymentsOrderInformationAmountDetails.js +1 -1
- package/src/model/Ptsv2paymentsPaymentInformationPaymentType.js +9 -0
- package/src/model/Ptsv2paymentsProcessingInformation.js +10 -1
- package/src/model/Ptsv2paymentsRecipientInformation.js +9 -0
- package/src/model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.js +1 -1
- package/src/model/TssV2TransactionsGet200Response.js +21 -4
- package/src/model/TssV2TransactionsGet200ResponsePaymentInformation.js +37 -4
- package/src/model/TssV2TransactionsGet200ResponsePaymentInformationBrands.js +91 -0
- package/src/model/TssV2TransactionsGet200ResponsePaymentInformationCard.js +18 -0
- package/src/model/TssV2TransactionsGet200ResponsePaymentInformationFeatures.js +136 -0
- package/src/model/TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.js +109 -0
- package/src/model/TssV2TransactionsGet200ResponsePaymentInformationNetwork.js +82 -0
- package/src/model/TssV2TransactionsGet200ResponsePayoutOptions.js +82 -0
- package/src/model/TssV2TransactionsGet200ResponseProcessingInformation.js +9 -0
- package/src/model/TssV2TransactionsGet200ResponseTokenInformation.js +18 -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
|
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**headerStyle** | [**InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle**](InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle.md) | | [optional]
|
|
11
11
|
**deliveryLanguage** | **String** | The language of the email that we send to your customers. Possible values are `zh-CN`, `zh-TW`, `en-US`, `fr-FR`, `de-DE`, `ja-JP`, `pt-BR`, `ru-RU` and `es-419`. | [optional]
|
|
12
12
|
**defaultCurrencyCode** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional]
|
|
13
|
-
**payerAuthentication3DSVersion** | **
|
|
13
|
+
**payerAuthentication3DSVersion** | **Boolean** | The 3D Secure payer authentication status for a merchant's invoice payments. | [optional] [default to false]
|
|
14
|
+
**showVatNumber** | **Boolean** | Display VAT number on Invoice. | [optional] [default to false]
|
|
15
|
+
**vatRegistrationNumber** | **String** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. | [optional]
|
|
14
16
|
|
|
15
17
|
|
|
@@ -11,5 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**deliveryLanguage** | **String** | The language of the email that we send to your customers. Possible values are `zh-CN`, `zh-TW`, `en-US`, `fr-FR`, `de-DE`, `ja-JP`, `pt-BR`, `ru-RU` and `es-419`. | [optional]
|
|
12
12
|
**defaultCurrencyCode** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional]
|
|
13
13
|
**payerAuthenticationInInvoicing** | **String** | For a merchant's invoice payments, enable 3D Secure payer authentication version 1, update to 3D Secure version 2, or disable 3D Secure. Possible values are: - `enable` - `update` - `disable` | [optional]
|
|
14
|
+
**showVatNumber** | **Boolean** | Display VAT number on Invoice. | [optional] [default to false]
|
|
15
|
+
**vatRegistrationNumber** | **String** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. | [optional]
|
|
14
16
|
|
|
15
17
|
|
|
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**name** | **String** | Payer name for the invoice. | [optional]
|
|
7
7
|
**email** | **String** | 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. | [optional]
|
|
8
8
|
**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
|
|
9
|
+
**company** | [**Invoicingv2invoicesCustomerInformationCompany**](Invoicingv2invoicesCustomerInformationCompany.md) | | [optional]
|
|
9
10
|
|
|
10
11
|
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CyberSource.Invoicingv2invoicesCustomerInformationCompany
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Name of the customer’s company. **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 processor-specific information, see the `company_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
|
+
|
|
8
|
+
|
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**amount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional]
|
|
7
7
|
**taxable** | **Boolean** | Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0. If you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include `invoiceDetails.taxable` in the data it sends to the processor. For processor-specific information, see the `tax_indicator` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) Possible values: - **true** - **false** | [optional]
|
|
8
|
+
**taxRate** | **String** | Shipping Tax rate applied to the freight amount. **Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). **Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -7,5 +7,10 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**productName** | **String** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional]
|
|
8
8
|
**quantity** | **Number** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional]
|
|
9
9
|
**unitPrice** | **String** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional]
|
|
10
|
+
**discountAmount** | **String** | Discount applied to the item. | [optional]
|
|
11
|
+
**discountRate** | **String** | Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%) | [optional]
|
|
12
|
+
**taxAmount** | **String** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional]
|
|
13
|
+
**taxRate** | **String** | Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). **Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). | [optional]
|
|
14
|
+
**totalAmount** | **String** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional]
|
|
10
15
|
|
|
11
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/
|
|
61
|
+
- **Accept**: application/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/
|
|
107
|
+
- **Accept**: application/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/
|
|
153
|
+
- **Accept**: application/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/
|
|
199
|
+
- **Accept**: application/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/
|
|
245
|
+
- **Accept**: application/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/
|
|
285
|
+
- **Accept**: application/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/
|
|
340
|
+
- **Accept**: application/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/
|
|
389
|
+
- **Accept**: application/json;charset=utf-8
|
|
398
390
|
|
|
@@ -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
|
+
|
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**responseDetails** | **String** | This field might contain information about a decline. This field is supported only for **CyberSource through VisaNet**. | [optional]
|
|
14
14
|
**responseCategoryCode** | **String** | Processor-defined response category code. The associated detail error code is in the `processorInformation.responseCode` or `issuerInformation.responseCode` field of the service you requested. This field is supported only for: - Japanese issuers - Domestic transactions in Japan - Comercio Latino—processor transaction ID required for troubleshooting #### Maximum length for processors - Comercio Latino: 36 - All other processors: 3 | [optional]
|
|
15
15
|
**forwardedAcquirerCode** | **String** | Name of the Japanese acquirer that processed the transaction. Returned only for JCN Gateway. Please contact the CyberSource Japan Support Group for more information. | [optional]
|
|
16
|
+
**settlementDate** | **String** | Field contains a settlement date. The date is in mmdd format, where: mm = month and dd = day. | [optional]
|
|
16
17
|
**avs** | [**PtsV2PaymentsPost201ResponseProcessorInformationAvs**](PtsV2PaymentsPost201ResponseProcessorInformationAvs.md) | | [optional]
|
|
17
18
|
**cardVerification** | [**PtsV2PaymentsPost201ResponseProcessorInformationCardVerification**](PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md) | | [optional]
|
|
18
19
|
**merchantAdvice** | [**PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice**](PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md) | | [optional]
|
|
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**responseCode** | **String** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `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]
|
|
11
11
|
**achVerification** | [**PtsV2PaymentsPost201ResponseProcessorInformationAchVerification**](PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md) | | [optional]
|
|
12
12
|
**networkTransactionId** | **String** | Same value as `processorInformation.transactionId` | [optional]
|
|
13
|
+
**settlementDate** | **String** | Field contains a settlement date. The date is in mmdd format, where: mm = month and dd = day. | [optional]
|
|
13
14
|
|
|
14
15
|
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**balance** | **String** | This field shows the available balance in the prepaid account. Acquirers always receive the available balance in the transaction currency. | [optional]
|
|
7
|
-
**currency** | **String** | This
|
|
7
|
+
**currency** | **String** | This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. | [optional]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -27,7 +27,7 @@ Name | Type | Description | Notes
|
|
|
27
27
|
**serviceFeeAmount** | **String** | Service fee. Required for service fee transactions. | [optional]
|
|
28
28
|
**originalAmount** | **String** | Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places. | [optional]
|
|
29
29
|
**originalCurrency** | **String** | Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional]
|
|
30
|
-
**cashbackAmount** | **String** | Cashback amount in the acquirer’s currency. If a cashback amount is included in the request, it must be included in the `orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization** Optional. **Authorization Reversal** Optional. #### PIN debit
|
|
30
|
+
**cashbackAmount** | **String** | Cashback amount in the acquirer’s currency. If a cashback amount is included in the request, it must be included in the `orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization** Optional. **Authorization Reversal** Optional. #### PIN debit Optional field for PIN debit purchase, PIN debit credit or PIN debit reversal. | [optional]
|
|
31
31
|
**currencyConversion** | [**Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion**](Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion.md) | | [optional]
|
|
32
32
|
|
|
33
33
|
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**name** | **String** | A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank, KCP) - `localCard` (KCP Local card via Altpay) - `carrierBilling` (KCP Carrier Billing via Altpay) | [optional]
|
|
7
|
+
**subTypeName** | **String** | Detailed information about the Payment Type. Possible values: - `DEBIT`: Use this value to indicate a PIN debit transaction. Examples: For Card, if Credit or Debit or PrePaid. For Bank Transfer, if Online Bank Transfer or Wire Transfers. | [optional]
|
|
7
8
|
**method** | [**Ptsv2paymentsPaymentInformationPaymentTypeMethod**](Ptsv2paymentsPaymentInformationPaymentTypeMethod.md) | | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -3,9 +3,10 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**actionList** | **[String]** | Array of actions (one or more) to be included in the payment to invoke bundled services along with payment. Possible values are one or more of follows: - `DECISION_SKIP`: Use this when you want to skip Decision Manager service(s). - `TOKEN_CREATE`: Use this when you want to create a token from the card/bank data in your payment request. - `CONSUMER_AUTHENTICATION`: Use this when you want to check if a card is enrolled in Payer
|
|
6
|
+
**actionList** | **[String]** | Array of actions (one or more) to be included in the payment to invoke bundled services along with payment. Possible values are one or more of follows: - `DECISION_SKIP`: Use this when you want to skip Decision Manager service(s). - `TOKEN_CREATE`: Use this when you want to create a token from the card/bank data in your payment request. - `CONSUMER_AUTHENTICATION`: Use this when you want to check if a card is enrolled in Payer Authentication along with your payment request. - `VALIDATE_CONSUMER_AUTHENTICATION`: Use this after you acquire a Payer Authentication result that needs to be included for your payment request. - `AP_INITIATE`: Use this when Alternative Payment Initiate service is requested. - `WATCHLIST_SCREENING` : Use this when you want to call Watchlist Screening service. | [optional]
|
|
7
7
|
**enableEscrowOption** | **Boolean** | Indicates whether to use the customer’s escrow agreement. Possible values: - `true`: yes, use the customer’s escrow agreement. - `false`: no, do not use the customer’s escrow agreement. | [optional]
|
|
8
8
|
**actionTokenTypes** | **[String]** | CyberSource tokens types you are performing a create on. If not supplied the default token type for the merchants token vault will be used. Valid values: - customer - paymentInstrument - instrumentIdentifier - shippingAddress | [optional]
|
|
9
|
+
**binSource** | **String** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional]
|
|
9
10
|
**capture** | **Boolean** | Indicates whether to also include a capture in the submitted authorization request or not. Possible values: - `true`: Include a capture with an authorization request. - `false`: (default) Do not include a capture with an authorization request. #### Used by **Authorization and Capture** Optional field. | [optional] [default to false]
|
|
10
11
|
**processorId** | **String** | Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. Contact CyberSource Customer Support to get the value for this field. | [optional]
|
|
11
12
|
**businessApplicationId** | **String** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. For valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf) | [optional]
|
|
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**lastName** | **String** | Recipient’s last name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_lastname` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
|
|
8
8
|
**middleName** | **String** | Recipient’s middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_middlename` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
|
|
9
9
|
**postalCode** | **String** | Partial postal code for the recipient’s address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_postal_code` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
|
|
10
|
+
**dateOfBirth** | **String** | Recipient’s date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional]
|
|
10
11
|
|
|
11
12
|
|
|
@@ -22,6 +22,6 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**taxDetails** | [**[Ptsv2paymentsOrderInformationAmountDetailsTaxDetails]**](Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional]
|
|
23
23
|
**serviceFeeAmount** | **String** | Service fee. Required for service fee transactions. | [optional]
|
|
24
24
|
**originalCurrency** | **String** | Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional]
|
|
25
|
-
**cashbackAmount** | **String** | Cashback amount in the acquirer’s currency. If a cashback amount is included in the request, it must be included in the `orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization** Optional. **Authorization Reversal** Optional. #### PIN debit
|
|
25
|
+
**cashbackAmount** | **String** | Cashback amount in the acquirer’s currency. If a cashback amount is included in the request, it must be included in the `orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization** Optional. **Authorization Reversal** Optional. #### PIN debit Optional field for PIN debit purchase, PIN debit credit or PIN debit reversal. | [optional]
|
|
26
26
|
|
|
27
27
|
|
package/docs/SubscriptionsApi.md
CHANGED
|
@@ -16,7 +16,7 @@ Method | HTTP request | Description
|
|
|
16
16
|
|
|
17
17
|
<a name="activateSubscription"></a>
|
|
18
18
|
# **activateSubscription**
|
|
19
|
-
> InlineResponse2009 activateSubscription(id
|
|
19
|
+
> InlineResponse2009 activateSubscription(id)
|
|
20
20
|
|
|
21
21
|
Activate a Subscription
|
|
22
22
|
|
|
@@ -30,9 +30,6 @@ var apiInstance = new CyberSource.SubscriptionsApi();
|
|
|
30
30
|
|
|
31
31
|
var id = "id_example"; // String | Subscription Id
|
|
32
32
|
|
|
33
|
-
var opts = {
|
|
34
|
-
'activateSubscriptionRequest': 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.activateSubscription(id,
|
|
41
|
+
apiInstance.activateSubscription(id, callback);
|
|
45
42
|
```
|
|
46
43
|
|
|
47
44
|
### Parameters
|
|
@@ -49,7 +46,6 @@ apiInstance.activateSubscription(id, opts, callback);
|
|
|
49
46
|
Name | Type | Description | Notes
|
|
50
47
|
------------- | ------------- | ------------- | -------------
|
|
51
48
|
**id** | **String**| Subscription Id |
|
|
52
|
-
**activateSubscriptionRequest** | **Object**| | [optional]
|
|
53
49
|
|
|
54
50
|
### Return type
|
|
55
51
|
|
|
@@ -62,11 +58,11 @@ No authorization required
|
|
|
62
58
|
### HTTP request headers
|
|
63
59
|
|
|
64
60
|
- **Content-Type**: application/json;charset=utf-8
|
|
65
|
-
- **Accept**: application/
|
|
61
|
+
- **Accept**: application/json;charset=utf-8
|
|
66
62
|
|
|
67
63
|
<a name="cancelSubscription"></a>
|
|
68
64
|
# **cancelSubscription**
|
|
69
|
-
> InlineResponse202 cancelSubscription(id
|
|
65
|
+
> InlineResponse202 cancelSubscription(id)
|
|
70
66
|
|
|
71
67
|
Cancel a Subscription
|
|
72
68
|
|
|
@@ -80,9 +76,6 @@ var apiInstance = new CyberSource.SubscriptionsApi();
|
|
|
80
76
|
|
|
81
77
|
var id = "id_example"; // String | Subscription Id
|
|
82
78
|
|
|
83
|
-
var opts = {
|
|
84
|
-
'cancelSubscriptionRequest': null // Object |
|
|
85
|
-
};
|
|
86
79
|
|
|
87
80
|
var callback = function(error, data, response) {
|
|
88
81
|
if (error) {
|
|
@@ -91,7 +84,7 @@ var callback = function(error, data, response) {
|
|
|
91
84
|
console.log('API called successfully. Returned data: ' + data);
|
|
92
85
|
}
|
|
93
86
|
};
|
|
94
|
-
apiInstance.cancelSubscription(id,
|
|
87
|
+
apiInstance.cancelSubscription(id, callback);
|
|
95
88
|
```
|
|
96
89
|
|
|
97
90
|
### Parameters
|
|
@@ -99,7 +92,6 @@ apiInstance.cancelSubscription(id, opts, callback);
|
|
|
99
92
|
Name | Type | Description | Notes
|
|
100
93
|
------------- | ------------- | ------------- | -------------
|
|
101
94
|
**id** | **String**| Subscription Id |
|
|
102
|
-
**cancelSubscriptionRequest** | **Object**| | [optional]
|
|
103
95
|
|
|
104
96
|
### Return type
|
|
105
97
|
|
|
@@ -112,7 +104,7 @@ No authorization required
|
|
|
112
104
|
### HTTP request headers
|
|
113
105
|
|
|
114
106
|
- **Content-Type**: application/json;charset=utf-8
|
|
115
|
-
- **Accept**: application/
|
|
107
|
+
- **Accept**: application/json;charset=utf-8
|
|
116
108
|
|
|
117
109
|
<a name="createSubscription"></a>
|
|
118
110
|
# **createSubscription**
|
|
@@ -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/
|
|
153
|
+
- **Accept**: application/json;charset=utf-8
|
|
162
154
|
|
|
163
155
|
<a name="getAllSubscriptions"></a>
|
|
164
156
|
# **getAllSubscriptions**
|
|
@@ -211,7 +203,7 @@ No authorization required
|
|
|
211
203
|
### HTTP request headers
|
|
212
204
|
|
|
213
205
|
- **Content-Type**: application/json;charset=utf-8
|
|
214
|
-
- **Accept**: application/
|
|
206
|
+
- **Accept**: application/json;charset=utf-8
|
|
215
207
|
|
|
216
208
|
<a name="getSubscription"></a>
|
|
217
209
|
# **getSubscription**
|
|
@@ -257,7 +249,7 @@ No authorization required
|
|
|
257
249
|
### HTTP request headers
|
|
258
250
|
|
|
259
251
|
- **Content-Type**: application/json;charset=utf-8
|
|
260
|
-
- **Accept**: application/
|
|
252
|
+
- **Accept**: application/json;charset=utf-8
|
|
261
253
|
|
|
262
254
|
<a name="getSubscriptionCode"></a>
|
|
263
255
|
# **getSubscriptionCode**
|
|
@@ -297,11 +289,11 @@ No authorization required
|
|
|
297
289
|
### HTTP request headers
|
|
298
290
|
|
|
299
291
|
- **Content-Type**: application/json;charset=utf-8
|
|
300
|
-
- **Accept**: application/
|
|
292
|
+
- **Accept**: application/json;charset=utf-8
|
|
301
293
|
|
|
302
294
|
<a name="suspendSubscription"></a>
|
|
303
295
|
# **suspendSubscription**
|
|
304
|
-
> InlineResponse2021 suspendSubscription(id
|
|
296
|
+
> InlineResponse2021 suspendSubscription(id)
|
|
305
297
|
|
|
306
298
|
Suspend a Subscription
|
|
307
299
|
|
|
@@ -315,9 +307,6 @@ var apiInstance = new CyberSource.SubscriptionsApi();
|
|
|
315
307
|
|
|
316
308
|
var id = "id_example"; // String | Subscription Id
|
|
317
309
|
|
|
318
|
-
var opts = {
|
|
319
|
-
'suspendSubscriptionRequest': null // Object |
|
|
320
|
-
};
|
|
321
310
|
|
|
322
311
|
var callback = function(error, data, response) {
|
|
323
312
|
if (error) {
|
|
@@ -326,7 +315,7 @@ var callback = function(error, data, response) {
|
|
|
326
315
|
console.log('API called successfully. Returned data: ' + data);
|
|
327
316
|
}
|
|
328
317
|
};
|
|
329
|
-
apiInstance.suspendSubscription(id,
|
|
318
|
+
apiInstance.suspendSubscription(id, callback);
|
|
330
319
|
```
|
|
331
320
|
|
|
332
321
|
### Parameters
|
|
@@ -334,7 +323,6 @@ apiInstance.suspendSubscription(id, opts, callback);
|
|
|
334
323
|
Name | Type | Description | Notes
|
|
335
324
|
------------- | ------------- | ------------- | -------------
|
|
336
325
|
**id** | **String**| Subscription Id |
|
|
337
|
-
**suspendSubscriptionRequest** | **Object**| | [optional]
|
|
338
326
|
|
|
339
327
|
### Return type
|
|
340
328
|
|
|
@@ -347,7 +335,7 @@ No authorization required
|
|
|
347
335
|
### HTTP request headers
|
|
348
336
|
|
|
349
337
|
- **Content-Type**: application/json;charset=utf-8
|
|
350
|
-
- **Accept**: application/
|
|
338
|
+
- **Accept**: application/json;charset=utf-8
|
|
351
339
|
|
|
352
340
|
<a name="updateSubscription"></a>
|
|
353
341
|
# **updateSubscription**
|
|
@@ -396,5 +384,5 @@ No authorization required
|
|
|
396
384
|
### HTTP request headers
|
|
397
385
|
|
|
398
386
|
- **Content-Type**: application/json;charset=utf-8
|
|
399
|
-
- **Accept**: application/
|
|
387
|
+
- **Accept**: application/json;charset=utf-8
|
|
400
388
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**reconciliationId** | **String** | Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. | [optional]
|
|
9
9
|
**merchantId** | **String** | Your CyberSource merchant ID. | [optional]
|
|
10
10
|
**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]
|
|
11
|
+
**status** | **String** | The status of the submitted transaction. | [optional]
|
|
11
12
|
**applicationInformation** | [**TssV2TransactionsGet200ResponseApplicationInformation**](TssV2TransactionsGet200ResponseApplicationInformation.md) | | [optional]
|
|
12
13
|
**buyerInformation** | [**TssV2TransactionsGet200ResponseBuyerInformation**](TssV2TransactionsGet200ResponseBuyerInformation.md) | | [optional]
|
|
13
14
|
**clientReferenceInformation** | [**TssV2TransactionsGet200ResponseClientReferenceInformation**](TssV2TransactionsGet200ResponseClientReferenceInformation.md) | | [optional]
|
|
@@ -22,6 +23,7 @@ Name | Type | Description | Notes
|
|
|
22
23
|
**orderInformation** | [**TssV2TransactionsGet200ResponseOrderInformation**](TssV2TransactionsGet200ResponseOrderInformation.md) | | [optional]
|
|
23
24
|
**paymentInformation** | [**TssV2TransactionsGet200ResponsePaymentInformation**](TssV2TransactionsGet200ResponsePaymentInformation.md) | | [optional]
|
|
24
25
|
**paymentInsightsInformation** | [**PtsV2PaymentsPost201ResponsePaymentInsightsInformation**](PtsV2PaymentsPost201ResponsePaymentInsightsInformation.md) | | [optional]
|
|
26
|
+
**payoutOptions** | [**TssV2TransactionsGet200ResponsePayoutOptions**](TssV2TransactionsGet200ResponsePayoutOptions.md) | | [optional]
|
|
25
27
|
**processingInformation** | [**TssV2TransactionsGet200ResponseProcessingInformation**](TssV2TransactionsGet200ResponseProcessingInformation.md) | | [optional]
|
|
26
28
|
**processorInformation** | [**TssV2TransactionsGet200ResponseProcessorInformation**](TssV2TransactionsGet200ResponseProcessorInformation.md) | | [optional]
|
|
27
29
|
**pointOfSaleInformation** | [**TssV2TransactionsGet200ResponsePointOfSaleInformation**](TssV2TransactionsGet200ResponsePointOfSaleInformation.md) | | [optional]
|
|
@@ -6,7 +6,11 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**paymentType** | [**TssV2TransactionsGet200ResponsePaymentInformationPaymentType**](TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md) | | [optional]
|
|
7
7
|
**customer** | [**TssV2TransactionsGet200ResponsePaymentInformationCustomer**](TssV2TransactionsGet200ResponsePaymentInformationCustomer.md) | | [optional]
|
|
8
8
|
**card** | [**TssV2TransactionsGet200ResponsePaymentInformationCard**](TssV2TransactionsGet200ResponsePaymentInformationCard.md) | | [optional]
|
|
9
|
+
**brands** | [**[TssV2TransactionsGet200ResponsePaymentInformationBrands]**](TssV2TransactionsGet200ResponsePaymentInformationBrands.md) | This array contains the supported brands. | [optional]
|
|
10
|
+
**features** | [**TssV2TransactionsGet200ResponsePaymentInformationFeatures**](TssV2TransactionsGet200ResponsePaymentInformationFeatures.md) | | [optional]
|
|
9
11
|
**invoice** | [**TssV2TransactionsGet200ResponsePaymentInformationInvoice**](TssV2TransactionsGet200ResponsePaymentInformationInvoice.md) | | [optional]
|
|
12
|
+
**network** | [**TssV2TransactionsGet200ResponsePaymentInformationNetwork**](TssV2TransactionsGet200ResponsePaymentInformationNetwork.md) | | [optional]
|
|
13
|
+
**issuerInformation** | [**TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation**](TssV2TransactionsGet200ResponsePaymentInformationIssuerInformation.md) | | [optional]
|
|
10
14
|
**bank** | [**TssV2TransactionsGet200ResponsePaymentInformationBank**](TssV2TransactionsGet200ResponsePaymentInformationBank.md) | | [optional]
|
|
11
15
|
**accountFeatures** | [**TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures**](TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.md) | | [optional]
|
|
12
16
|
**paymentInstrument** | [**PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument**](PtsV2PaymentsPost201ResponseTokenInformationPaymentInstrument.md) | | [optional]
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CyberSource.TssV2TransactionsGet200ResponsePaymentInformationBrands
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**type** | **String** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay - '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 | [optional]
|
|
7
|
+
**brandName** | **String** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -11,6 +11,8 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**startYear** | **String** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional]
|
|
12
12
|
**issueNumber** | **String** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. | [optional]
|
|
13
13
|
**type** | **String** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `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 | [optional]
|
|
14
|
+
**brandName** | **String** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS | [optional]
|
|
15
|
+
**currency** | **String** | This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. | [optional]
|
|
14
16
|
**accountEncoderId** | **String** | Identifier for the issuing bank that provided the customer’s encoded account number. Contact your processor for the bank’s ID. | [optional]
|
|
15
17
|
**useAs** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. Possible values: - C: Credit transaction - D: Debit transaction This field is supported only for all card Types on Visa Platform Connect. This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **Note** The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 51 - Field: Combination Card Transaction Identifier | [optional]
|
|
16
18
|
|