Skip to content

Commit 5d1b68b

Browse files
api-spec changes
1 parent f665b97 commit 5d1b68b

File tree

409 files changed

+7410
-3121
lines changed

Some content is hidden

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

409 files changed

+7410
-3121
lines changed

docs/Api/InstrumentIdentifierApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ No authorization required
5959
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
6060

6161
# **getInstrumentIdentifier**
62-
> \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier getInstrumentIdentifier($instrumentIdentifierId, $profileId)
62+
> \CyberSource\Model\TmsEmbeddedInstrumentIdentifier getInstrumentIdentifier($instrumentIdentifierId, $profileId)
6363
6464
Retrieve an Instrument Identifier
6565

@@ -92,7 +92,7 @@ Name | Type | Description | Notes
9292

9393
### Return type
9494

95-
[**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier**](../Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier.md)
95+
[**\CyberSource\Model\TmsEmbeddedInstrumentIdentifier**](../Model/TmsEmbeddedInstrumentIdentifier.md)
9696

9797
### Authorization
9898

@@ -157,7 +157,7 @@ No authorization required
157157
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
158158

159159
# **patchInstrumentIdentifier**
160-
> \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier patchInstrumentIdentifier($instrumentIdentifierId, $patchInstrumentIdentifierRequest, $profileId, $ifMatch)
160+
> \CyberSource\Model\TmsEmbeddedInstrumentIdentifier patchInstrumentIdentifier($instrumentIdentifierId, $patchInstrumentIdentifierRequest, $profileId, $ifMatch)
161161
162162
Update an Instrument Identifier
163163

@@ -194,7 +194,7 @@ Name | Type | Description | Notes
194194

195195
### Return type
196196

197-
[**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier**](../Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier.md)
197+
[**\CyberSource\Model\TmsEmbeddedInstrumentIdentifier**](../Model/TmsEmbeddedInstrumentIdentifier.md)
198198

199199
### Authorization
200200

@@ -208,7 +208,7 @@ No authorization required
208208
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
209209

210210
# **postInstrumentIdentifier**
211-
> \CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier postInstrumentIdentifier($postInstrumentIdentifierRequest, $profileId)
211+
> \CyberSource\Model\TmsEmbeddedInstrumentIdentifier postInstrumentIdentifier($postInstrumentIdentifierRequest, $profileId)
212212
213213
Create an Instrument Identifier
214214

@@ -241,7 +241,7 @@ Name | Type | Description | Notes
241241

242242
### Return type
243243

244-
[**\CyberSource\Model\Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier**](../Model/Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier.md)
244+
[**\CyberSource\Model\TmsEmbeddedInstrumentIdentifier**](../Model/TmsEmbeddedInstrumentIdentifier.md)
245245

246246
### Authorization
247247

docs/Model/CardProcessingConfig.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CardProcessingConfig
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**common** | [**\CyberSource\Model\CardProcessingConfigCommon**](CardProcessingConfigCommon.md) | | [optional]
7+
**features** | [**\CyberSource\Model\CardProcessingConfigFeatures**](CardProcessingConfigFeatures.md) | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommon
1+
# CardProcessingConfigCommon
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**processors** | [**map[string,\CyberSource\Model\PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors]**](PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors.md) | e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with <your vpc processor> | [optional]
6+
**processors** | [**map[string,\CyberSource\Model\CardProcessingConfigCommonProcessors]**](CardProcessingConfigCommonProcessors.md) | e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with <your vpc processor> | [optional]
77
**amexVendorCode** | **string** | Vendor code assigned by American Express. Applicable for TSYS (tsys) processor. | [optional]
88
**defaultAuthTypeCode** | **string** | Authorization Finality indicator. Please note that the input can be in small case or capitals but response is in small case as of now. It will be made capitals everywhere in the next version. Applicable for Elavon Americas (elavonamericas), TSYS (tsys), Barclays (barclays2), Streamline (streamline2), Six (six), Barclays HISO (barclayshiso), GPN (gpn), FDI Global (fdiglobal), GPX (gpx), Paymentech Tampa (paymentechtampa), FDC Nashville (smartfdc), VPC and Chase Paymentech Salem (chasepaymentechsalem) 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>Barclays</td><td>cnp, cp, hybrid</td><td>No</td><td>FINAL</td></tr> <tr><td>Barclays HISO</td><td>cnp, cp, hybrid</td><td>Yes</td><td>FINAL</td></tr> </table> | [optional]
99
**masterCardAssignedId** | **string** | MAID aka MasterCard assigned ID, MasterCard equivalent of Merchant Verification Value by Visa. Applicable for VPC, GPX (gpx) and FDI Global (fdiglobal) processors. | [optional]
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
2323
**subMerchantId** | **string** | The ID assigned to the sub-merchant. 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>20</td><td>^[0-9a-zA-Z\-\_\,\\s.]+$</td></tr> </table> | [optional]
2424
**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\-\_\,\\s.]+$</td></tr> </table> | [optional]
2525
**preferCobadgedSecondaryBrand** | **bool** | It denotes merchant's preference on secondary brand for routing in case of co-branded cards. Applicable for EFTPOS processors. | [optional]
26-
**merchantDescriptorInformation** | [**\CyberSource\Model\PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation**](PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation.md) | | [optional]
26+
**merchantDescriptorInformation** | [**\CyberSource\Model\CardProcessingConfigCommonMerchantDescriptorInformation**](CardProcessingConfigCommonMerchantDescriptorInformation.md) | | [optional]
2727

2828
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
2929

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer
1+
# CardProcessingConfigCommonAcquirer
22

33
## Properties
44
Name | Type | Description | Notes
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies
1+
# CardProcessingConfigCommonCurrencies
22

33
## Properties
44
Name | Type | Description | Notes
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1
1+
# CardProcessingConfigCommonCurrencies1
22

33
## Properties
44
Name | Type | Description | Notes
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonMerchantDescriptorInformation
1+
# CardProcessingConfigCommonMerchantDescriptorInformation
22

33
## Properties
44
Name | Type | Description | Notes
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CardProcessingConfigCommonPaymentTypes
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**enabled** | **bool** | | [optional]
7+
**currencies** | [**map[string,\CyberSource\Model\CardProcessingConfigCommonCurrencies]**](CardProcessingConfigCommonCurrencies.md) | Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonProcessors
1+
# CardProcessingConfigCommonProcessors
22

33
## Properties
44
Name | Type | Description | Notes
@@ -7,11 +7,11 @@ Name | Type | Description | Notes
77
**businessApplicationId** | **string** | Indicates the type of money transfer used in the transaction. Applicable for VPC and GPX (gpx) processors. | [optional]
88
**merchantVerificationValue** | **string** | Identify merchants that participate in Select Merchant Fee (SMF) programs. Unique to the merchant. Applicable for GPX (gpx) and VPC processors. | [optional]
99
**abaNumber** | **string** | Routing Number to identify banks within the United States. Applicable for GPX (gpx) processors. | [optional]
10-
**acquirer** | [**\CyberSource\Model\PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer**](PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonAcquirer.md) | | [optional]
10+
**acquirer** | [**\CyberSource\Model\CardProcessingConfigCommonAcquirer**](CardProcessingConfigCommonAcquirer.md) | | [optional]
1111
**merchantId** | **string** | Merchant ID assigned by an acquirer or a processor. Should not be overriden by any other party. 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>cp, cnp, hybrid</td><td>Yes</td><td>1</td><td>15</td><td>^[0-9a-zA-Z]+$</td></tr> <tr><td>Barclays</td><td>cp, cnp, hybrid</td><td>Yes</td><td>1</td><td>11</td><td>^[0-9a-zA-Z]+$</td></tr> </table> |
1212
**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]
13-
**paymentTypes** | [**map[string,\CyberSource\Model\PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes]**](PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonPaymentTypes.md) | Valid values are: * VISA * MASTERCARD * AMERICAN_EXPRESS * CUP * EFTPOS * DINERS_CLUB * DISCOVER * JCB | [optional]
14-
**currencies** | [**map[string,\CyberSource\Model\PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1]**](PaymentsProductsCardProcessingConfigurationInformationConfigurationsCommonCurrencies1.md) | Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional]
13+
**paymentTypes** | [**map[string,\CyberSource\Model\CardProcessingConfigCommonPaymentTypes]**](CardProcessingConfigCommonPaymentTypes.md) | Valid values are: * VISA * MASTERCARD * AMERICAN_EXPRESS * CUP * EFTPOS * DINERS_CLUB * DISCOVER * JCB | [optional]
14+
**currencies** | [**map[string,\CyberSource\Model\CardProcessingConfigCommonCurrencies1]**](CardProcessingConfigCommonCurrencies1.md) | Three-character [ISO 4217 ALPHA-3 Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional]
1515
**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]
1616
**allowMultipleBills** | **bool** | 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]
1717
**allowMerchantDescriptorOverride** | **bool** | Enables partner to enable/disable merchant descriptors values. Applicable for VPC, EFTPOS and CUP processors. | [optional]
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CardProcessingConfigFeatures
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**cardNotPresent** | [**\CyberSource\Model\CardProcessingConfigFeaturesCardNotPresent**](CardProcessingConfigFeaturesCardNotPresent.md) | | [optional]
7+
**cardPresent** | [**\CyberSource\Model\CardProcessingConfigFeaturesCardPresent**](CardProcessingConfigFeaturesCardPresent.md) | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

0 commit comments

Comments
 (0)