Skip to content

Commit

Permalink
Merge pull request #151 from CyberSource/release-sep24
Browse files Browse the repository at this point in the history
api spec changes sep24
  • Loading branch information
monu-kumar-visa authored Sep 30, 2024
2 parents 4c2238b + 1725410 commit 28464db
Show file tree
Hide file tree
Showing 178 changed files with 12,518 additions and 629 deletions.
2 changes: 2 additions & 0 deletions docs/CardProcessingConfigCommon.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Name | Type | Description | Notes
**subMerchantBusinessName** | **String** | Sub-merchant's business name. Applicable for American Express Direct (amexdirect) processor. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>No</td><td>1</td><td>37</td><td>^[0-9a-zA-Z&#92;-&#92;_&#92;,\\s.]+$</td></tr> </table> | [optional]
**preferCobadgedSecondaryBrand** | **Boolean** | It denotes merchant's preference on secondary brand for routing in case of co-branded cards. Applicable for EFTPOS processors. | [optional]
**merchantDescriptorInformation** | [**CardProcessingConfigCommonMerchantDescriptorInformation**](CardProcessingConfigCommonMerchantDescriptorInformation.md) | | [optional]
**governmentControlled** | **Boolean** | Indicates whether the merchant is government controlled. Applicable for VPC processors. | [optional]
**dropBillingInfo** | **Boolean** | This field is used to indicate whether the merchant wants to drop the billing information from the request. If this field is set to true, then the billing information will be dropped from the request. If this field is set to false, then the billing information will be sent in the request. | [optional]


<a name="DefaultAuthTypeCodeEnum"></a>
Expand Down
2 changes: 2 additions & 0 deletions docs/CardProcessingConfigCommonAcquirer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Name | Type | Description | Notes
**institutionId** | **String** | Identifier of the acquirer. This number is usually assigned by Visa. Applicable for VPC, GPX (gpx), CMCIC (cmcic), EFTPOS, CB2A, CUP, American Express Direct (amexdirect) and Six (six) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>1</td><td>13</td><td>^[0-9]+$</td><td>1111</td></tr> </table> | [optional]
**interbankCardAssociationId** | **String** | Number assigned by MasterCard to banks to identify the member in transactions. Applicable for VPC and GPX (gpx) processors. | [optional]
**discoverInstitutionId** | **String** | Assigned by Discover to identify the acquirer. Applicable for VPC and GPX (gpx) processors. | [optional]
**unionPayInstitutionId** | **String** | Assigned by China Union Pay to identify the acquirer. Applicable for VPC processors. | [optional]
**dinersClubInstitutionId** | **String** | Assigned by Diners Club to identify the acquirer. Applicable for VPC processors. | [optional]
**countryCode** | **String** | ISO 4217 format. Applicable for VPC, GPX (gpx), EFTPOS, RUPAY, Prisma (prisma) and CUP processors. | [optional]
**fileDestinationBin** | **String** | The BIN to which this capturefile is sent. This field must contain a valid BIN. Applicable for VPC and GPX (gpx) processors. | [optional]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ Name | Type | Description | Notes
**street** | **String** | Applicable for American Express Direct (amexdirect), TSYS (tsys) and Elavon Americas (elavonamericas) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>1</td><td>38</td><td>^[0-9a-zA-Z\\s]+$</td></tr> </table> | [optional]
**zip** | **String** | Applicable for Elavon Americas (elavonamericas), RUPAY, American Express Direct (amexdirect) and TSYS (tsys) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>1</td><td>15</td><td>^[0-9a-zA-Z\\s]+$</td></tr> </table> | [optional]
**url** | **String** | Applicable for RUPAY and American Express Direct (amexdirect) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, hybrid</td><td>Yes</td><td>1</td><td>40</td><td>URL</td></tr> <tr><td>American Express Direct</td><td>cp</td><td>No</td><td>1</td><td>40</td><td>URL</td></tr> </table> | [optional]
**countryOfOrigin** | **String** | Country Cf Origin of merchant is applicable for VPC Processors and is dependent on governmentControlled attribute. | [optional]


3 changes: 3 additions & 0 deletions docs/CardProcessingConfigCommonProcessors.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Name | Type | Description | Notes
**terminalId** | **String** | The 'Terminal Id' aka TID, is an identifier used for with your payments processor. Depending on the processor and payment acceptance type this may also be the default Terminal ID used for Card Present and Virtual Terminal transactions. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>Barclays HISO</td><td>cnp, hybrid</td><td>Yes</td><td>1</td><td>16</td><td>^[0-9a-zA-Z]+$</td></tr> <tr><td>Barclays HISO</td><td>cp</td><td>No</td><td>1</td><td>16</td><td>^[0-9a-zA-Z]+$</td></tr> </table> | [optional]
**paymentTypes** | [**{String: CardProcessingConfigCommonPaymentTypes}**](CardProcessingConfigCommonPaymentTypes.md) | Valid values are: * VISA * MASTERCARD * AMERICAN_EXPRESS * CUP * EFTPOS * DINERS_CLUB * DISCOVER * JCB | [optional]
**currencies** | [**{String: CardProcessingConfigCommonCurrencies1}**](CardProcessingConfigCommonCurrencies1.md) | Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional]
**visaAggregatorId** | **String** | This field is used as aggregator Id when Visa payment type is selected | [optional]
**amexAggregatorId** | **String** | This field is used as aggregator Id when Amex payment type is selected | [optional]
**masterCardAggregatorId** | **String** | This field is used as aggregator Id when Master Card payment type is selected | [optional]
**sicCode** | **String** | The Standard Industrial Classification (SIC) are four-digit codes that categorize the industries that companies belong to based on their business activities. Standard Industrial Classification codes were mostly replaced by the six-digit North American Industry Classification System (NAICS). Applicable for VPC and GPX (gpx) processors. | [optional]
**allowMultipleBills** | **Boolean** | Allows multiple captures for a single authorization transaction. Applicable for Paymentech Tampa (paymentechtampa), VPC, American Express Direct (amexdirect) and GPX (gpx) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>American Express Direct</td><td>cp, hybrid</td><td>Yes</td><td>No</td></tr> <tr><td>American Express Direct</td><td>cnp</td><td>No</td><td>No</td></tr> </table> | [optional]
**allowMerchantDescriptorOverride** | **Boolean** | Enables partner to enable/disable merchant descriptors values. Applicable for VPC, EFTPOS and CUP processors. | [optional]
Expand Down
55 changes: 55 additions & 0 deletions docs/FlexAPIApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# CyberSource.FlexAPIApi

All URIs are relative to *https://apitest.cybersource.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**generateFlexAPICaptureContext**](FlexAPIApi.md#generateFlexAPICaptureContext) | **POST** /flex/v2/sessions | Establish a Payment Session with a Capture Context


<a name="generateFlexAPICaptureContext"></a>
# **generateFlexAPICaptureContext**
> 'String' generateFlexAPICaptureContext(generateFlexAPICaptureContextRequest)
Establish a Payment Session with a Capture Context

To establish a payment session, include the API fields you plan to use in that session in the body of the request. The system then returns a JSON Web Token (JWT) that includes the capture context. To determine which fields to include in your capture context, identify the personal information that you wish to isolate from the payment session. **Capture Context Fields**<br> When making a session request, any fields that you request to be added to the capture context are required by default. However, you can choose to make a field optional by setting the required parameter to false.

### Example
```javascript
var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.FlexAPIApi();

var generateFlexAPICaptureContextRequest = new CyberSource.GenerateFlexAPICaptureContextRequest(); // GenerateFlexAPICaptureContextRequest |


var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.generateFlexAPICaptureContext(generateFlexAPICaptureContextRequest, callback);
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**generateFlexAPICaptureContextRequest** | [**GenerateFlexAPICaptureContextRequest**](GenerateFlexAPICaptureContextRequest.md)| |

### Return type

**'String'**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/jwt

9 changes: 9 additions & 0 deletions docs/Flexv2sessionsFields.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CyberSource.Flexv2sessionsFields

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**orderInformation** | [**Flexv2sessionsFieldsOrderInformation**](Flexv2sessionsFieldsOrderInformation.md) | | [optional]
**paymentInformation** | [**Flexv2sessionsFieldsPaymentInformation**](Flexv2sessionsFieldsPaymentInformation.md) | | [optional]


10 changes: 10 additions & 0 deletions docs/Flexv2sessionsFieldsOrderInformation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CyberSource.Flexv2sessionsFieldsOrderInformation

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**amountDetails** | [**Flexv2sessionsFieldsOrderInformationAmountDetails**](Flexv2sessionsFieldsOrderInformationAmountDetails.md) | | [optional]
**billTo** | [**Flexv2sessionsFieldsOrderInformationBillTo**](Flexv2sessionsFieldsOrderInformationBillTo.md) | | [optional]
**shipTo** | [**Flexv2sessionsFieldsOrderInformationShipTo**](Flexv2sessionsFieldsOrderInformationShipTo.md) | | [optional]


9 changes: 9 additions & 0 deletions docs/Flexv2sessionsFieldsOrderInformationAmountDetails.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CyberSource.Flexv2sessionsFieldsOrderInformationAmountDetails

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**totalAmount** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**currency** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]


Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# CyberSource.Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**required** | **Boolean** | | [optional]


20 changes: 20 additions & 0 deletions docs/Flexv2sessionsFieldsOrderInformationBillTo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# CyberSource.Flexv2sessionsFieldsOrderInformationBillTo

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**address1** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**address2** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**administrativeArea** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**buildingNumber** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**country** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**district** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**locality** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**postalCode** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**email** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**firstName** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**lastName** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**phoneNumber** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**company** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]


18 changes: 18 additions & 0 deletions docs/Flexv2sessionsFieldsOrderInformationShipTo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CyberSource.Flexv2sessionsFieldsOrderInformationShipTo

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**address1** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**address2** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**administrativeArea** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**buildingNumber** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**country** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**district** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**locality** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**postalCode** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**firstName** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**lastName** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**company** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]


8 changes: 8 additions & 0 deletions docs/Flexv2sessionsFieldsPaymentInformation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# CyberSource.Flexv2sessionsFieldsPaymentInformation

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**card** | [**Flexv2sessionsFieldsPaymentInformationCard**](Flexv2sessionsFieldsPaymentInformationCard.md) | | [optional]


12 changes: 12 additions & 0 deletions docs/Flexv2sessionsFieldsPaymentInformationCard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# CyberSource.Flexv2sessionsFieldsPaymentInformationCard

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_number** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**type** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**securityCode** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**expirationMonth** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]
**expirationYear** | [**Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount**](Flexv2sessionsFieldsOrderInformationAmountDetailsTotalAmount.md) | | [optional]


8 changes: 8 additions & 0 deletions docs/GenerateFlexAPICaptureContextRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# CyberSource.GenerateFlexAPICaptureContextRequest

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fields** | [**Flexv2sessionsFields**](Flexv2sessionsFields.md) | | [optional]


47 changes: 42 additions & 5 deletions docs/InlineResponse4001.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,47 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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]
**status** | **String** | The status of the submitted transaction. Possible values: - `INVALID_REQUEST` | [optional]
**reason** | **String** | The reason of the status. Possible Values: - `INVALID_DATA` | [optional]
**message** | **String** | Input request error. | [optional]
**details** | [**[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional]
**correlationId** | **String** | | [optional]
**details** | [**[InlineResponse4001Details]**](InlineResponse4001Details.md) | | [optional]
**informationLink** | **String** | | [optional]
**message** | **String** | |
**reason** | **String** | |


<a name="ReasonEnum"></a>
## Enum: ReasonEnum


* `INVALID_APIKEY` (value: `"INVALID_APIKEY"`)

* `INVALID_SHIPPING_INPUT_PARAMS` (value: `"INVALID_SHIPPING_INPUT_PARAMS"`)

* `CAPTURE_CONTEXT_INVALID` (value: `"CAPTURE_CONTEXT_INVALID"`)

* `CAPTURE_CONTEXT_EXPIRED` (value: `"CAPTURE_CONTEXT_EXPIRED"`)

* `SDK_XHR_ERROR` (value: `"SDK_XHR_ERROR"`)

* `UNIFIEDPAYMENTS_VALIDATION_PARAMS` (value: `"UNIFIEDPAYMENTS_VALIDATION_PARAMS"`)

* `UNIFIEDPAYMENTS_VALIDATION_FIELDS` (value: `"UNIFIEDPAYMENTS_VALIDATION_FIELDS"`)

* `UNIFIEDPAYMENT_PAYMENT_PARAMITERS` (value: `"UNIFIEDPAYMENT_PAYMENT_PARAMITERS"`)

* `CREATE_TOKEN_TIMEOUT` (value: `"CREATE_TOKEN_TIMEOUT"`)

* `CREATE_TOKEN_XHR_ERROR` (value: `"CREATE_TOKEN_XHR_ERROR"`)

* `SHOW_LOAD_CONTAINER_SELECTOR` (value: `"SHOW_LOAD_CONTAINER_SELECTOR"`)

* `SHOW_LOAD_INVALID_CONTAINER` (value: `"SHOW_LOAD_INVALID_CONTAINER"`)

* `SHOW_TOKEN_TIMEOUT` (value: `"SHOW_TOKEN_TIMEOUT"`)

* `SHOW_TOKEN_XHR_ERROR` (value: `"SHOW_TOKEN_XHR_ERROR"`)

* `SHOW_PAYMENT_TIMEOUT` (value: `"SHOW_PAYMENT_TIMEOUT"`)




9 changes: 9 additions & 0 deletions docs/InlineResponse4001Details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CyberSource.InlineResponse4001Details

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**location** | **String** | | [optional]
**message** | **String** | | [optional]


Loading

0 comments on commit 28464db

Please sign in to comment.