Skip to content

Commit c32ade5

Browse files
authored
Merge pull request #71 from snavinch/master
+ July 2021 SDK Release & OAuth Change
2 parents 1fbe5a7 + ae3cb8d commit c32ade5

File tree

78 files changed

+2194
-265
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+2194
-265
lines changed

docs/AccessTokenResponse.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# CyberSource.AccessTokenResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**accessToken** | **String** | Created JWT token. | [optional]
7+
**tokenType** | **String** | Bearer. | [optional]
8+
**refreshToken** | **String** | Newly created JWT token for initial request or if refresh token expired, else the same refresh token as in the request. | [optional]
9+
**expiresIn** | **Number** | Number of seconds left till the access token gets expired. | [optional]
10+
**scope** | **String** | List of permissions for APIs. | [optional]
11+
**refreshTokenExpiresIn** | **Number** | Number of seconds left till the refresh token gets expired. | [optional]
12+
**clientStatus** | **String** | Successful response can be returned only if client status is active. | [optional]
13+
14+

docs/BadRequestError.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CyberSource.BadRequestError
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**error** | **String** | | [optional]
7+
**errorDescription** | **String** | | [optional]
8+
9+

docs/CreateAccessTokenRequest.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CyberSource.CreateAccessTokenRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**clientId** | **String** | The client ID that you received when you registered your application in the CyberSource Business Center. This identifies your client application. |
7+
**clientSecret** | **String** | The client secret that you received when you registered your application in the CyberSource Business Center. |
8+
**grantType** | **String** | The grant type value determines which type of flow is used to obtain the access token. The first time your application requests a token, use the value `authorization_code`. When you use this value, you must also include the `code` field in the request. For subsequent request, use `refresh_token`. When you use this value, you must also include the `refresh_token` field in the request. Valid values: - authorization_code - refresh_token | [optional]
9+
**code** | **String** | This value is sent by CyberSource in the redirect URL. For security reasons, the code expires in 10 minutes. If it expires, you must repeat the redirect to request another. Conditional. This value is equired if grant_type is `authorization_code`. | [optional]
10+
**refreshToken** | **String** | Conditional. Required if grant_type is `refresh_token`. | [optional]
11+
12+

docs/InvoicingV2InvoicesAllGet200ResponseCustomerInformation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**name** | **String** | Payer name for the invoice. | [optional]
7+
**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]
78

89

docs/Invoicingv2invoicesCustomerInformation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**name** | **String** | Payer name for the invoice. | [optional]
77
**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+
**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]
89

910

docs/OAuthApi.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# CyberSource.OAuthApi
2+
3+
All URIs are relative to *https://api-ma.Cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**createAccessToken**](OAuthApi.md#createAccessToken) | **POST** /oauth2/v3/token | Create access token and refresh token
8+
9+
10+
<a name="createAccessToken"></a>
11+
# **createAccessToken**
12+
> AccessTokenResponse createAccessToken(createAccessTokenRequest, opts)
13+
14+
Create access token and refresh token
15+
16+
This request is used by technology partners to obtain an access token and a refresh token, which are contained in the response. The partner can then use the access token for authentication when submitting API requests to CyberSource on behalf of the merchant. The request must include the authorization code that was included in the URL redirect response from CyberSource (see [full documentation](https://developer.cybersource.com/api/developer-guides/OAuth/cybs_extend_intro.html)). Access tokens expire after 15 minutes. The refresh token is used to create a new access token, it expires after one year.
17+
18+
### Example
19+
```javascript
20+
var CyberSource = require('CyberSource');
21+
22+
var apiInstance = new CyberSource.OAuthApi();
23+
24+
var createAccessTokenRequest = new CyberSource.CreateAccessTokenRequest(); // CreateAccessTokenRequest | Request payload
25+
26+
var opts = {
27+
'vCClientCorrelationId': "vCClientCorrelationId_example" // String | We recommended that you submit this header with a unique value in every client request to this endpoint. It is sent back in the response header and logged both in the request log and response log.
28+
};
29+
30+
var callback = function(error, data, response) {
31+
if (error) {
32+
console.error(error);
33+
} else {
34+
console.log('API called successfully. Returned data: ' + data);
35+
}
36+
};
37+
apiInstance.createAccessToken(createAccessTokenRequest, opts, callback);
38+
```
39+
40+
### Parameters
41+
42+
Name | Type | Description | Notes
43+
------------- | ------------- | ------------- | -------------
44+
**createAccessTokenRequest** | [**CreateAccessTokenRequest**](CreateAccessTokenRequest.md)| Request payload |
45+
**vCClientCorrelationId** | **String**| We recommended that you submit this header with a unique value in every client request to this endpoint. It is sent back in the response header and logged both in the request log and response log. | [optional]
46+
47+
### Return type
48+
49+
[**AccessTokenResponse**](AccessTokenResponse.md)
50+
51+
### Authorization
52+
53+
No authorization required
54+
55+
### HTTP request headers
56+
57+
- **Content-Type**: application/x-www-form-urlencoded
58+
- **Accept**: application/json;charset=utf-8
59+

docs/PaymentsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Method | HTTP request | Description
1414
1515
Process a Payment
1616

17-
A payment authorizes the amount for the transaction. There are a number of supported payment feature, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc.. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-payments/GettingStarted.html). Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation. Find more on [Authorization with Add-On Features page.] (https://developer.cybersource.com/api/authorization-add-ons.html) Possible [RESPONSE CODES](https://developer.cybersource.com/api/reference/response-codes.html) . Processor specific [Testing Triggers](https://developer.cybersource.com/hello-world/testing-guide.html).
17+
A payment authorizes the amount for the transaction. There are a number of supported payment feature, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc.. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-payments/GettingStarted.html). Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation. Find more on [Authorization with Add-On Features page.](https://developer.cybersource.com/api/authorization-add-ons.html)
1818

1919
### Example
2020
```javascript

docs/PtsV2PaymentsPost201Response.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
**processingInformation** | [**PtsV2PaymentsPost201ResponseProcessingInformation**](PtsV2PaymentsPost201ResponseProcessingInformation.md) | | [optional]
1414
**processorInformation** | [**PtsV2PaymentsPost201ResponseProcessorInformation**](PtsV2PaymentsPost201ResponseProcessorInformation.md) | | [optional]
1515
**issuerInformation** | [**PtsV2PaymentsPost201ResponseIssuerInformation**](PtsV2PaymentsPost201ResponseIssuerInformation.md) | | [optional]
16+
**paymentAccountInformation** | [**PtsV2PaymentsPost201ResponsePaymentAccountInformation**](PtsV2PaymentsPost201ResponsePaymentAccountInformation.md) | | [optional]
1617
**paymentInformation** | [**PtsV2PaymentsPost201ResponsePaymentInformation**](PtsV2PaymentsPost201ResponsePaymentInformation.md) | | [optional]
1718
**orderInformation** | [**PtsV2PaymentsPost201ResponseOrderInformation**](PtsV2PaymentsPost201ResponseOrderInformation.md) | | [optional]
1819
**pointOfSaleInformation** | [**PtsV2PaymentsPost201ResponsePointOfSaleInformation**](PtsV2PaymentsPost201ResponsePointOfSaleInformation.md) | | [optional]
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CyberSource.PtsV2PaymentsPost201ResponsePaymentAccountInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**card** | [**PtsV2PaymentsPost201ResponsePaymentAccountInformationCard**](PtsV2PaymentsPost201ResponsePaymentAccountInformationCard.md) | | [optional]
7+
8+

docs/PtsV2PaymentsPost201ResponsePaymentInformationCard.md renamed to docs/PtsV2PaymentsPost201ResponsePaymentAccountInformationCard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CyberSource.PtsV2PaymentsPost201ResponsePaymentInformationCard
1+
# CyberSource.PtsV2PaymentsPost201ResponsePaymentAccountInformationCard
22

33
## Properties
44
Name | Type | Description | Notes

0 commit comments

Comments
 (0)