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,20 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsOrderInformationBillTo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**address1** | **String** | Payment card billing street address as it appears on the credit card issuer’s records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
|
|
7
|
+
**address2** | **String** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate `orderInformation.billTo.address1` and `orderInformation.billTo.address2`, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional]
|
|
8
|
+
**administrativeArea** | **String** | State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
|
|
9
|
+
**buildingNumber** | **String** | Building number in the street address. For example, if the street address is: Rua da Quitanda 187 then the building number is 187. This field is supported only for: - Cielo transactions. - Redecard customer validation with CyberSource Latin American Processing. | [optional]
|
|
10
|
+
**company** | **String** | Company's Name, e.g. VISA | [optional]
|
|
11
|
+
**country** | **String** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
|
|
12
|
+
**district** | **String** | Customer’s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on **Cielo**. | [optional]
|
|
13
|
+
**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]
|
|
14
|
+
**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
|
|
15
|
+
**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
|
|
16
|
+
**locality** | **String** | Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
|
|
17
|
+
**phoneNumber** | **String** | Customer’s phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
|
|
18
|
+
**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field. | [optional]
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsPaymentInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**card** | [**Ptsv2billingagreementsPaymentInformationCard**](Ptsv2billingagreementsPaymentInformationCard.md) | | [optional]
|
|
7
|
+
**tokenizedCard** | [**Ptsv2billingagreementsPaymentInformationTokenizedCard**](Ptsv2billingagreementsPaymentInformationTokenizedCard.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsPaymentInformationCard
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional]
|
|
7
|
+
**expirationYear** | **String** | Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. | [optional]
|
|
8
|
+
**_number** | **String** | The customer’s payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
|
|
9
|
+
**securityCode** | **String** | Card Verification Number. #### FDMS Nashville Required for American Express or if swiped; otherwise, optional. #### Ingenico ePayments Do not include this field when `commerceIndicator=recurring`. **Note** Ingenico ePayments was previously called _Global Collect_. #### TSYS Acquiring Solutions Optional if pointOfSaleInformation.entryMode=keyed; otherwise, not used. #### GPX Optional. #### All other processors: Optional. | [optional]
|
|
10
|
+
**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]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsPaymentInformationTokenizedCard
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**cryptogram** | **String** | This field contains token information. | [optional]
|
|
7
|
+
**expirationMonth** | **String** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
|
|
8
|
+
**expirationYear** | **String** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional]
|
|
9
|
+
**_number** | **String** | Customer’s payment network token value. | [optional]
|
|
10
|
+
**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional]
|
|
11
|
+
**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]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CyberSource.Ptsv2billingagreementsProcessingInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**commerceIndicator** | **String** | Type of transaction. Used to determine fees based on channel. Possible values: - aesk: American Express SafeKey authentication was successful. - aesk_attempted: American Express SafeKey authentication was attempted but did not succeed. • install: Installment payment. - install_internet: Non-U.S. e-commerce (Internet) installment payment. This value is supported only on Visa Platform Connect. - internet (default for authorizations): E-commerce order placed using a web site. - js: JCB J/Secure authentication was successful. - js_attempted: JCB J/Secure authentication was attempted but did not succeed. - moto: Mail order or telephone order. - moto_cc: Mail order or telephone order from a call center. This value is supported only on the Asia, Middle East, and Africa Gateway. - pb: ProtectBuy authentication was successful. - pb_attempted: ProtectBuy authentication was attempted but did not succeed. - recurring: Recurring payment that is a U.S. transaction or non-U.S. mail order / telephone order (MOTO) transaction. - recurring_internet: Recurring payment that is a non-U.S. e-commerce (Internet) transaction. - retail: Card-present transaction. - spa: For Mastercard Identity Check: Authentication was successful or was attempted but did not succeed. The e-commerce indicator for all Mastercard Identity Check transactions, including authentication attempts, must be set to spa. - spa_attempted: Authentication for a co-badged Mastercard and Cartes Bancaires card was attempted but did not succeed. - spa_failure: – For Mastercard Identity Check: Authentication failed. This value is supported only on Elavon, HSBC, and Streamline. - vbv: – For Visa Secure: Authentication was successful. - vbv_attempted: – For Visa Secure: Authentication was attempted but did not succeed. - vbv_failure: – For Visa Secure: Authentication failed. This value is supported only on HSBC and Streamline. | [optional]
|
|
7
|
+
**actionList** | **[String]** | - Use `CONSUMER_AUTHENTICATION` to use Payer Authentication along with Decision Manager. For any other value, only Decision Manager will run. - Use `WATCHLIST_SCREENING` when you want to call Watchlist Screening service. - Use `UPDATE_AGREEMENT` - Use `BILLING_AGREEMENT_CREATE` - Use `CANCEL_AGREEMENT` | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**shippingDetails** | [**Ptsv2paymentsOrderInformationShippingDetails**](Ptsv2paymentsOrderInformationShippingDetails.md) | | [optional]
|
|
12
12
|
**returnsAccepted** | **Boolean** | This is only needed when you are requesting both payment and DM service at same time. Boolean that indicates whether returns are accepted for this order. This field can contain one of the following values: - true: Returns are accepted for this order. - false: Returns are not accepted for this order. | [optional]
|
|
13
13
|
**isCryptocurrencyPurchase** | **String** | #### Visa Platform Connect : This API will contain the Flag that specifies whether the payment is for the purchase of cryptocurrency. Additional values to add : This API will contain the Flag that specifies whether the payment is for the purchase of cryptocurrency. valid values are - Y/y, true - N/n, false | [optional]
|
|
14
|
+
**cutoffDateTime** | **String** | Starting date and time for an event or a journey that is independent of which transportation mechanism, in UTC. The cutoffDateTime will supersede travelInformation.transit.airline.legs[].departureDate and travelInformation.transit.airline.legs[].departureTime if these fields are supplied in the request. 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. | [optional]
|
|
14
15
|
**preOrder** | **String** | Indicates whether cardholder is placing an order with a future availability or release date. This field can contain one of these values: - MERCHANDISE_AVAILABLE: Merchandise available - FUTURE_AVAILABILITY: Future availability | [optional]
|
|
15
16
|
**preOrderDate** | **String** | Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD | [optional]
|
|
16
17
|
**reordered** | **Boolean** | Indicates whether the cardholder is reordering previously purchased merchandise. This field can contain one of these values: - false: First time ordered - true: Reordered | [optional]
|
|
@@ -3,7 +3,7 @@
|
|
|
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
9
|
**binSource** | **String** | Bin Source File Identifier. Possible values: - itmx - rupay | [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
|
|
|
@@ -4,5 +4,6 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**transientToken** | **String** | A temporary ID that represents the customer's payment data (which is securely stored in Visa Data Centers). Flex Microform generates this ID and sets it to expire within 15 minutes from when the ID is generated or until the first payment authorization is carried out (whichever occurs first). Valid value for the ID is a 64-character, alphanumeric string. Example: 1D08M4YB968R1F7YVL4TBBKYVNRIR02VZFH9CBYSQIJJXORPI1NK5C98D7F6EB53 | [optional]
|
|
7
|
+
**jti** | **String** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [optional]
|
|
7
8
|
|
|
8
9
|
|
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**amountDetails** | [**Riskv1decisionsOrderInformationAmountDetails**](Riskv1decisionsOrderInformationAmountDetails.md) | | [optional]
|
|
7
7
|
**preOrder** | **String** | Indicates whether cardholder is placing an order with a future availability or release date. This field can contain one of these values: - MERCHANDISE_AVAILABLE: Merchandise available - FUTURE_AVAILABILITY: Future availability | [optional]
|
|
8
8
|
**preOrderDate** | **String** | Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD | [optional]
|
|
9
|
+
**cutoffDateTime** | **String** | Starting date and time for an event or a journey that is independent of which transportation mechanism, in UTC. The cutoffDateTime will supersede travelInformation.departureTime if both are supplied in the request. 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. | [optional]
|
|
9
10
|
**reordered** | **Boolean** | Indicates whether the cardholder is reordering previously purchased merchandise. This field can contain one of these values: - false: First time ordered - true: Reordered | [optional]
|
|
10
11
|
**shippingDetails** | [**Riskv1decisionsOrderInformationShippingDetails**](Riskv1decisionsOrderInformationShippingDetails.md) | | [optional]
|
|
11
12
|
**shipTo** | [**Riskv1decisionsOrderInformationShipTo**](Riskv1decisionsOrderInformationShipTo.md) | | [optional]
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CyberSource.Riskv1decisionsTokenInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**jti** | **String** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [optional]
|
|
7
|
+
|
|
8
|
+
|
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/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="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/hal+json;charset=utf-8
|
|
107
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+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/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="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/hal+json;charset=utf-8
|
|
206
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+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/hal+json;charset=utf-8
|
|
252
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+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/hal+json;charset=utf-8
|
|
292
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+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/hal+json;charset=utf-8
|
|
338
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+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/hal+json;charset=utf-8
|
|
387
|
+
- **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+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]
|
|
@@ -13,7 +13,6 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**sort** | **String** | A comma separated list of the following form: `submitTimeUtc:desc` | [optional]
|
|
14
14
|
**count** | **Number** | Results for this page, this could be below the limit. | [optional]
|
|
15
15
|
**totalCount** | **Number** | Total number of results. | [optional]
|
|
16
|
-
**status** | **String** | The status of the submitted transaction. | [optional]
|
|
17
16
|
**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]
|
|
18
17
|
**embedded** | [**TssV2TransactionsPost201ResponseEmbedded**](TssV2TransactionsPost201ResponseEmbedded.md) | | [optional]
|
|
19
18
|
**links** | [**PtsV2IncrementalAuthorizationPatch201ResponseLinks**](PtsV2IncrementalAuthorizationPatch201ResponseLinks.md) | | [optional]
|
|
@@ -5,6 +5,8 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**name** | **String** | The name of the CyberSource transaction type (such as CC settlement or CC authorization) that the merchant wants to process in a transaction request. More than one transaction type can included in a transaction request. Each transaction type separately returns their own status, reasonCode, rCode, and rFlag messages. | [optional]
|
|
7
7
|
**reasonCode** | **String** | 3-digit reason code that indicates why the customer profile payment succeeded or failed. | [optional]
|
|
8
|
+
**status** | **String** | The status of the submitted transaction. Note: This field may not be returned for all transactions. | [optional]
|
|
9
|
+
**reason** | **String** | Description of why a request failed. Note: This field may not be returned for all transactions. | [optional]
|
|
8
10
|
**rCode** | **String** | Indicates whether the service request was successful. Possible values: - `-1`: An error occurred. - `0`: The request was declined. - `1`: The request was successful. | [optional]
|
|
9
11
|
**rFlag** | **String** | One-word description of the result of the application. | [optional]
|
|
10
12
|
**reconciliationId** | **String** | Reference number that you use to reconcile your CyberSource reports with your processor reports. | [optional]
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CyberSource.TssV2TransactionsPost201ResponseEmbeddedErrorInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**reason** | **String** | Description of why a request failed. Note: This field may not be returned for all transactions. | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -6,11 +6,13 @@ Name | Type | Description | Notes
|
|
|
6
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
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
8
|
**merchantId** | **String** | Your CyberSource merchant ID. | [optional]
|
|
9
|
+
**status** | **String** | The status of the submitted transaction. Note: This field may not be returned for all transactions. | [optional]
|
|
9
10
|
**applicationInformation** | [**TssV2TransactionsPost201ResponseEmbeddedApplicationInformation**](TssV2TransactionsPost201ResponseEmbeddedApplicationInformation.md) | | [optional]
|
|
10
11
|
**buyerInformation** | [**TssV2TransactionsPost201ResponseEmbeddedBuyerInformation**](TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md) | | [optional]
|
|
11
12
|
**clientReferenceInformation** | [**TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation**](TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md) | | [optional]
|
|
12
13
|
**consumerAuthenticationInformation** | [**TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation**](TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md) | | [optional]
|
|
13
14
|
**deviceInformation** | [**Riskv1authenticationresultsDeviceInformation**](Riskv1authenticationresultsDeviceInformation.md) | | [optional]
|
|
15
|
+
**errorInformation** | [**TssV2TransactionsPost201ResponseEmbeddedErrorInformation**](TssV2TransactionsPost201ResponseEmbeddedErrorInformation.md) | | [optional]
|
|
14
16
|
**fraudMarkingInformation** | [**TssV2TransactionsGet200ResponseFraudMarkingInformation**](TssV2TransactionsGet200ResponseFraudMarkingInformation.md) | | [optional]
|
|
15
17
|
**merchantDefinedInformation** | [**[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | The object containing the custom data that the merchant defines. | [optional]
|
|
16
18
|
**merchantInformation** | [**TssV2TransactionsPost201ResponseEmbeddedMerchantInformation**](TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md) | | [optional]
|
package/docs/ValidateRequest.md
CHANGED
|
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**paymentInformation** | [**Riskv1authenticationresultsPaymentInformation**](Riskv1authenticationresultsPaymentInformation.md) | | [optional]
|
|
10
10
|
**consumerAuthenticationInformation** | [**Riskv1authenticationresultsConsumerAuthenticationInformation**](Riskv1authenticationresultsConsumerAuthenticationInformation.md) | | [optional]
|
|
11
11
|
**deviceInformation** | [**Riskv1authenticationresultsDeviceInformation**](Riskv1authenticationresultsDeviceInformation.md) | | [optional]
|
|
12
|
+
**tokenInformation** | [**Riskv1decisionsTokenInformation**](Riskv1decisionsTokenInformation.md) | | [optional]
|
|
12
13
|
|
|
13
14
|
|
package/package.json
CHANGED
package/src/ApiClient.js
CHANGED
|
@@ -528,7 +528,9 @@
|
|
|
528
528
|
if (httpMethod.toLowerCase() === this.constants.POST
|
|
529
529
|
|| httpMethod.toLowerCase() === this.constants.PATCH
|
|
530
530
|
|| httpMethod.toLowerCase() === this.constants.PUT) {
|
|
531
|
-
|
|
531
|
+
if (bodyParam !== "{}") {
|
|
532
|
+
bodyParam = JSON.stringify(bodyParam, null, 0);
|
|
533
|
+
}
|
|
532
534
|
}
|
|
533
535
|
|
|
534
536
|
if (this.merchantConfig.getAuthenticationType().toLowerCase() !== this.constants.MUTUAL_AUTH)
|