Skip to content

Commit e9b1fb2

Browse files
author
Hari
committed
Updating docs
1 parent 5987927 commit e9b1fb2

File tree

313 files changed

+5705
-554
lines changed

Some content is hidden

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

313 files changed

+5705
-554
lines changed

docs/AuthReversalRequest.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**clientReferenceInformation** | [**V2paymentsidreversalsClientReferenceInformation**](V2paymentsidreversalsClientReferenceInformation.md) | | [optional]
7-
**reversalInformation** | [**V2paymentsidreversalsReversalInformation**](V2paymentsidreversalsReversalInformation.md) | | [optional]
8-
**processingInformation** | [**V2paymentsidreversalsProcessingInformation**](V2paymentsidreversalsProcessingInformation.md) | | [optional]
9-
**orderInformation** | [**V2paymentsidreversalsOrderInformation**](V2paymentsidreversalsOrderInformation.md) | | [optional]
10-
**pointOfSaleInformation** | [**V2paymentsidreversalsPointOfSaleInformation**](V2paymentsidreversalsPointOfSaleInformation.md) | | [optional]
6+
**clientReferenceInformation** | [**Ptsv2paymentsidreversalsClientReferenceInformation**](Ptsv2paymentsidreversalsClientReferenceInformation.md) | | [optional]
7+
**reversalInformation** | [**Ptsv2paymentsidreversalsReversalInformation**](Ptsv2paymentsidreversalsReversalInformation.md) | | [optional]
8+
**processingInformation** | [**Ptsv2paymentsidreversalsProcessingInformation**](Ptsv2paymentsidreversalsProcessingInformation.md) | | [optional]
9+
**orderInformation** | [**Ptsv2paymentsidreversalsOrderInformation**](Ptsv2paymentsidreversalsOrderInformation.md) | | [optional]
10+
**pointOfSaleInformation** | [**Ptsv2paymentsidreversalsPointOfSaleInformation**](Ptsv2paymentsidreversalsPointOfSaleInformation.md) | | [optional]
1111

1212

docs/Body.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**links** | [**InstrumentidentifiersLinks**](InstrumentidentifiersLinks.md) | | [optional]
6+
**links** | [**Tmsv1instrumentidentifiersLinks**](Tmsv1instrumentidentifiersLinks.md) | | [optional]
77
**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional]
88
**_object** | **String** | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional]
99
**state** | **String** | Current state of the token. | [optional]
10-
**card** | [**InstrumentidentifiersCard**](InstrumentidentifiersCard.md) | | [optional]
11-
**bankAccount** | [**InstrumentidentifiersBankAccount**](InstrumentidentifiersBankAccount.md) | | [optional]
12-
**processingInformation** | [**InstrumentidentifiersProcessingInformation**](InstrumentidentifiersProcessingInformation.md) | | [optional]
13-
**metadata** | [**InstrumentidentifiersMetadata**](InstrumentidentifiersMetadata.md) | | [optional]
10+
**card** | [**Tmsv1instrumentidentifiersCard**](Tmsv1instrumentidentifiersCard.md) | | [optional]
11+
**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional]
12+
**processingInformation** | [**Tmsv1instrumentidentifiersProcessingInformation**](Tmsv1instrumentidentifiersProcessingInformation.md) | | [optional]
13+
**metadata** | [**Tmsv1instrumentidentifiersMetadata**](Tmsv1instrumentidentifiersMetadata.md) | | [optional]
1414

1515

1616
<a name="ObjectEnum"></a>

docs/Body1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**processingInformation** | [**InstrumentidentifiersProcessingInformation**](InstrumentidentifiersProcessingInformation.md) | | [optional]
6+
**processingInformation** | [**Tmsv1instrumentidentifiersProcessingInformation**](Tmsv1instrumentidentifiersProcessingInformation.md) | | [optional]
77

88

docs/Body2.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**links** | [**InstrumentidentifiersLinks**](InstrumentidentifiersLinks.md) | | [optional]
6+
**links** | [**Tmsv1instrumentidentifiersLinks**](Tmsv1instrumentidentifiersLinks.md) | | [optional]
77
**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional]
88
**_object** | **String** | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional]
99
**state** | **String** | Current state of the token. | [optional]
10-
**bankAccount** | [**PaymentinstrumentsBankAccount**](PaymentinstrumentsBankAccount.md) | | [optional]
11-
**card** | [**PaymentinstrumentsCard**](PaymentinstrumentsCard.md) | | [optional]
12-
**buyerInformation** | [**PaymentinstrumentsBuyerInformation**](PaymentinstrumentsBuyerInformation.md) | | [optional]
13-
**billTo** | [**PaymentinstrumentsBillTo**](PaymentinstrumentsBillTo.md) | | [optional]
14-
**processingInformation** | [**PaymentinstrumentsProcessingInformation**](PaymentinstrumentsProcessingInformation.md) | | [optional]
15-
**merchantInformation** | [**PaymentinstrumentsMerchantInformation**](PaymentinstrumentsMerchantInformation.md) | | [optional]
16-
**metaData** | [**InstrumentidentifiersMetadata**](InstrumentidentifiersMetadata.md) | | [optional]
17-
**instrumentIdentifier** | [**PaymentinstrumentsInstrumentIdentifier**](PaymentinstrumentsInstrumentIdentifier.md) | | [optional]
10+
**bankAccount** | [**Tmsv1paymentinstrumentsBankAccount**](Tmsv1paymentinstrumentsBankAccount.md) | | [optional]
11+
**card** | [**Tmsv1paymentinstrumentsCard**](Tmsv1paymentinstrumentsCard.md) | | [optional]
12+
**buyerInformation** | [**Tmsv1paymentinstrumentsBuyerInformation**](Tmsv1paymentinstrumentsBuyerInformation.md) | | [optional]
13+
**billTo** | [**Tmsv1paymentinstrumentsBillTo**](Tmsv1paymentinstrumentsBillTo.md) | | [optional]
14+
**processingInformation** | [**Tmsv1paymentinstrumentsProcessingInformation**](Tmsv1paymentinstrumentsProcessingInformation.md) | | [optional]
15+
**merchantInformation** | [**Tmsv1paymentinstrumentsMerchantInformation**](Tmsv1paymentinstrumentsMerchantInformation.md) | | [optional]
16+
**metaData** | [**Tmsv1instrumentidentifiersMetadata**](Tmsv1instrumentidentifiersMetadata.md) | | [optional]
17+
**instrumentIdentifier** | [**Tmsv1paymentinstrumentsInstrumentIdentifier**](Tmsv1paymentinstrumentsInstrumentIdentifier.md) | | [optional]
1818

1919

2020
<a name="ObjectEnum"></a>

docs/Body3.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**links** | [**InstrumentidentifiersLinks**](InstrumentidentifiersLinks.md) | | [optional]
6+
**links** | [**Tmsv1instrumentidentifiersLinks**](Tmsv1instrumentidentifiersLinks.md) | | [optional]
77
**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional]
88
**_object** | **String** | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional]
99
**state** | **String** | Current state of the token. | [optional]
10-
**bankAccount** | [**PaymentinstrumentsBankAccount**](PaymentinstrumentsBankAccount.md) | | [optional]
11-
**card** | [**PaymentinstrumentsCard**](PaymentinstrumentsCard.md) | | [optional]
12-
**buyerInformation** | [**PaymentinstrumentsBuyerInformation**](PaymentinstrumentsBuyerInformation.md) | | [optional]
13-
**billTo** | [**PaymentinstrumentsBillTo**](PaymentinstrumentsBillTo.md) | | [optional]
14-
**processingInformation** | [**PaymentinstrumentsProcessingInformation**](PaymentinstrumentsProcessingInformation.md) | | [optional]
15-
**merchantInformation** | [**PaymentinstrumentsMerchantInformation**](PaymentinstrumentsMerchantInformation.md) | | [optional]
16-
**metaData** | [**InstrumentidentifiersMetadata**](InstrumentidentifiersMetadata.md) | | [optional]
17-
**instrumentIdentifier** | [**PaymentinstrumentsInstrumentIdentifier**](PaymentinstrumentsInstrumentIdentifier.md) | | [optional]
10+
**bankAccount** | [**Tmsv1paymentinstrumentsBankAccount**](Tmsv1paymentinstrumentsBankAccount.md) | | [optional]
11+
**card** | [**Tmsv1paymentinstrumentsCard**](Tmsv1paymentinstrumentsCard.md) | | [optional]
12+
**buyerInformation** | [**Tmsv1paymentinstrumentsBuyerInformation**](Tmsv1paymentinstrumentsBuyerInformation.md) | | [optional]
13+
**billTo** | [**Tmsv1paymentinstrumentsBillTo**](Tmsv1paymentinstrumentsBillTo.md) | | [optional]
14+
**processingInformation** | [**Tmsv1paymentinstrumentsProcessingInformation**](Tmsv1paymentinstrumentsProcessingInformation.md) | | [optional]
15+
**merchantInformation** | [**Tmsv1paymentinstrumentsMerchantInformation**](Tmsv1paymentinstrumentsMerchantInformation.md) | | [optional]
16+
**metaData** | [**Tmsv1instrumentidentifiersMetadata**](Tmsv1instrumentidentifiersMetadata.md) | | [optional]
17+
**instrumentIdentifier** | [**Tmsv1paymentinstrumentsInstrumentIdentifier**](Tmsv1paymentinstrumentsInstrumentIdentifier.md) | | [optional]
1818

1919

2020
<a name="ObjectEnum"></a>

docs/CaptureApi.md

+6-53
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
# CyberSource.CaptureApi
22

3-
All URIs are relative to *https://api.cybersource.com*
3+
All URIs are relative to *https://apitest.cybersource.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**capturePayment**](CaptureApi.md#capturePayment) | **POST** /v2/payments/{id}/captures | Capture a Payment
8-
[**getCapture**](CaptureApi.md#getCapture) | **GET** /v2/captures/{id} | Retrieve a Capture
7+
[**capturePayment**](CaptureApi.md#capturePayment) | **POST** /pts/v2/payments/{id}/captures | Capture a Payment
98

109

1110
<a name="capturePayment"></a>
1211
# **capturePayment**
13-
> InlineResponse2012 capturePayment(capturePaymentRequest, id)
12+
> PtsV2PaymentsCapturesPost201Response capturePayment(capturePaymentRequest, id)
1413
1514
Capture a Payment
1615

@@ -46,60 +45,14 @@ Name | Type | Description | Notes
4645

4746
### Return type
4847

49-
[**InlineResponse2012**](InlineResponse2012.md)
48+
[**PtsV2PaymentsCapturesPost201Response**](PtsV2PaymentsCapturesPost201Response.md)
5049

5150
### Authorization
5251

5352
No authorization required
5453

5554
### HTTP request headers
5655

57-
- **Content-Type**: Not defined
58-
- **Accept**: application/json
59-
60-
<a name="getCapture"></a>
61-
# **getCapture**
62-
> InlineResponse2004 getCapture(id)
63-
64-
Retrieve a Capture
65-
66-
Include the capture ID in the GET request to retrieve the capture details.
67-
68-
### Example
69-
```javascript
70-
var CyberSource = require('CyberSource');
71-
72-
var apiInstance = new CyberSource.CaptureApi();
73-
74-
var id = "id_example"; // String | The capture ID returned from a previous capture request.
75-
76-
77-
var callback = function(error, data, response) {
78-
if (error) {
79-
console.error(error);
80-
} else {
81-
console.log('API called successfully. Returned data: ' + data);
82-
}
83-
};
84-
apiInstance.getCapture(id, callback);
85-
```
86-
87-
### Parameters
88-
89-
Name | Type | Description | Notes
90-
------------- | ------------- | ------------- | -------------
91-
**id** | **String**| The capture ID returned from a previous capture request. |
92-
93-
### Return type
94-
95-
[**InlineResponse2004**](InlineResponse2004.md)
96-
97-
### Authorization
98-
99-
No authorization required
100-
101-
### HTTP request headers
102-
103-
- **Content-Type**: Not defined
104-
- **Accept**: application/json
56+
- **Content-Type**: application/json;charset=utf-8
57+
- **Accept**: application/json;charset=utf-8
10558

docs/CapturePaymentRequest.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**clientReferenceInformation** | [**V2paymentsClientReferenceInformation**](V2paymentsClientReferenceInformation.md) | | [optional]
7-
**processingInformation** | [**V2paymentsidcapturesProcessingInformation**](V2paymentsidcapturesProcessingInformation.md) | | [optional]
8-
**paymentInformation** | [**V2paymentsidcapturesPaymentInformation**](V2paymentsidcapturesPaymentInformation.md) | | [optional]
9-
**orderInformation** | [**V2paymentsidcapturesOrderInformation**](V2paymentsidcapturesOrderInformation.md) | | [optional]
10-
**buyerInformation** | [**V2paymentsidcapturesBuyerInformation**](V2paymentsidcapturesBuyerInformation.md) | | [optional]
11-
**deviceInformation** | [**V2paymentsDeviceInformation**](V2paymentsDeviceInformation.md) | | [optional]
12-
**merchantInformation** | [**V2paymentsidcapturesMerchantInformation**](V2paymentsidcapturesMerchantInformation.md) | | [optional]
13-
**aggregatorInformation** | [**V2paymentsidcapturesAggregatorInformation**](V2paymentsidcapturesAggregatorInformation.md) | | [optional]
14-
**pointOfSaleInformation** | [**V2paymentsidcapturesPointOfSaleInformation**](V2paymentsidcapturesPointOfSaleInformation.md) | | [optional]
15-
**merchantDefinedInformation** | [**[V2paymentsMerchantDefinedInformation]**](V2paymentsMerchantDefinedInformation.md) | TBD | [optional]
6+
**clientReferenceInformation** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional]
7+
**processingInformation** | [**Ptsv2paymentsidcapturesProcessingInformation**](Ptsv2paymentsidcapturesProcessingInformation.md) | | [optional]
8+
**paymentInformation** | [**Ptsv2paymentsidcapturesPaymentInformation**](Ptsv2paymentsidcapturesPaymentInformation.md) | | [optional]
9+
**orderInformation** | [**Ptsv2paymentsidcapturesOrderInformation**](Ptsv2paymentsidcapturesOrderInformation.md) | | [optional]
10+
**buyerInformation** | [**Ptsv2paymentsidcapturesBuyerInformation**](Ptsv2paymentsidcapturesBuyerInformation.md) | | [optional]
11+
**deviceInformation** | [**Ptsv2paymentsDeviceInformation**](Ptsv2paymentsDeviceInformation.md) | | [optional]
12+
**merchantInformation** | [**Ptsv2paymentsidcapturesMerchantInformation**](Ptsv2paymentsidcapturesMerchantInformation.md) | | [optional]
13+
**aggregatorInformation** | [**Ptsv2paymentsidcapturesAggregatorInformation**](Ptsv2paymentsidcapturesAggregatorInformation.md) | | [optional]
14+
**pointOfSaleInformation** | [**Ptsv2paymentsidcapturesPointOfSaleInformation**](Ptsv2paymentsidcapturesPointOfSaleInformation.md) | | [optional]
15+
**merchantDefinedInformation** | [**[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | Description of this field is not available. | [optional]
1616

1717

docs/CreateCreditRequest.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**clientReferenceInformation** | [**V2paymentsClientReferenceInformation**](V2paymentsClientReferenceInformation.md) | | [optional]
7-
**processingInformation** | [**V2creditsProcessingInformation**](V2creditsProcessingInformation.md) | | [optional]
8-
**paymentInformation** | [**V2paymentsidrefundsPaymentInformation**](V2paymentsidrefundsPaymentInformation.md) | | [optional]
9-
**orderInformation** | [**V2paymentsidrefundsOrderInformation**](V2paymentsidrefundsOrderInformation.md) | | [optional]
10-
**buyerInformation** | [**V2paymentsidcapturesBuyerInformation**](V2paymentsidcapturesBuyerInformation.md) | | [optional]
11-
**deviceInformation** | [**V2paymentsDeviceInformation**](V2paymentsDeviceInformation.md) | | [optional]
12-
**merchantInformation** | [**V2paymentsidrefundsMerchantInformation**](V2paymentsidrefundsMerchantInformation.md) | | [optional]
13-
**aggregatorInformation** | [**V2paymentsidcapturesAggregatorInformation**](V2paymentsidcapturesAggregatorInformation.md) | | [optional]
14-
**pointOfSaleInformation** | [**V2creditsPointOfSaleInformation**](V2creditsPointOfSaleInformation.md) | | [optional]
15-
**merchantDefinedInformation** | [**[V2paymentsMerchantDefinedInformation]**](V2paymentsMerchantDefinedInformation.md) | TBD | [optional]
6+
**clientReferenceInformation** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional]
7+
**processingInformation** | [**Ptsv2creditsProcessingInformation**](Ptsv2creditsProcessingInformation.md) | | [optional]
8+
**paymentInformation** | [**Ptsv2paymentsidrefundsPaymentInformation**](Ptsv2paymentsidrefundsPaymentInformation.md) | | [optional]
9+
**orderInformation** | [**Ptsv2paymentsidrefundsOrderInformation**](Ptsv2paymentsidrefundsOrderInformation.md) | | [optional]
10+
**buyerInformation** | [**Ptsv2paymentsidcapturesBuyerInformation**](Ptsv2paymentsidcapturesBuyerInformation.md) | | [optional]
11+
**deviceInformation** | [**Ptsv2paymentsDeviceInformation**](Ptsv2paymentsDeviceInformation.md) | | [optional]
12+
**merchantInformation** | [**Ptsv2paymentsidrefundsMerchantInformation**](Ptsv2paymentsidrefundsMerchantInformation.md) | | [optional]
13+
**aggregatorInformation** | [**Ptsv2paymentsidcapturesAggregatorInformation**](Ptsv2paymentsidcapturesAggregatorInformation.md) | | [optional]
14+
**pointOfSaleInformation** | [**Ptsv2creditsPointOfSaleInformation**](Ptsv2creditsPointOfSaleInformation.md) | | [optional]
15+
**merchantDefinedInformation** | [**[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | Description of this field is not available. | [optional]
1616

1717

docs/CreatePaymentRequest.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**clientReferenceInformation** | [**V2paymentsClientReferenceInformation**](V2paymentsClientReferenceInformation.md) | | [optional]
7-
**processingInformation** | [**V2paymentsProcessingInformation**](V2paymentsProcessingInformation.md) | | [optional]
8-
**paymentInformation** | [**V2paymentsPaymentInformation**](V2paymentsPaymentInformation.md) | | [optional]
9-
**orderInformation** | [**V2paymentsOrderInformation**](V2paymentsOrderInformation.md) | | [optional]
10-
**buyerInformation** | [**V2paymentsBuyerInformation**](V2paymentsBuyerInformation.md) | | [optional]
11-
**recipientInformation** | [**V2paymentsRecipientInformation**](V2paymentsRecipientInformation.md) | | [optional]
12-
**deviceInformation** | [**V2paymentsDeviceInformation**](V2paymentsDeviceInformation.md) | | [optional]
13-
**merchantInformation** | [**V2paymentsMerchantInformation**](V2paymentsMerchantInformation.md) | | [optional]
14-
**aggregatorInformation** | [**V2paymentsAggregatorInformation**](V2paymentsAggregatorInformation.md) | | [optional]
15-
**consumerAuthenticationInformation** | [**V2paymentsConsumerAuthenticationInformation**](V2paymentsConsumerAuthenticationInformation.md) | | [optional]
16-
**pointOfSaleInformation** | [**V2paymentsPointOfSaleInformation**](V2paymentsPointOfSaleInformation.md) | | [optional]
17-
**merchantDefinedInformation** | [**[V2paymentsMerchantDefinedInformation]**](V2paymentsMerchantDefinedInformation.md) | TBD | [optional]
6+
**clientReferenceInformation** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional]
7+
**processingInformation** | [**Ptsv2paymentsProcessingInformation**](Ptsv2paymentsProcessingInformation.md) | | [optional]
8+
**paymentInformation** | [**Ptsv2paymentsPaymentInformation**](Ptsv2paymentsPaymentInformation.md) | | [optional]
9+
**orderInformation** | [**Ptsv2paymentsOrderInformation**](Ptsv2paymentsOrderInformation.md) | | [optional]
10+
**buyerInformation** | [**Ptsv2paymentsBuyerInformation**](Ptsv2paymentsBuyerInformation.md) | | [optional]
11+
**recipientInformation** | [**Ptsv2paymentsRecipientInformation**](Ptsv2paymentsRecipientInformation.md) | | [optional]
12+
**deviceInformation** | [**Ptsv2paymentsDeviceInformation**](Ptsv2paymentsDeviceInformation.md) | | [optional]
13+
**merchantInformation** | [**Ptsv2paymentsMerchantInformation**](Ptsv2paymentsMerchantInformation.md) | | [optional]
14+
**aggregatorInformation** | [**Ptsv2paymentsAggregatorInformation**](Ptsv2paymentsAggregatorInformation.md) | | [optional]
15+
**consumerAuthenticationInformation** | [**Ptsv2paymentsConsumerAuthenticationInformation**](Ptsv2paymentsConsumerAuthenticationInformation.md) | | [optional]
16+
**pointOfSaleInformation** | [**Ptsv2paymentsPointOfSaleInformation**](Ptsv2paymentsPointOfSaleInformation.md) | | [optional]
17+
**merchantDefinedInformation** | [**[Ptsv2paymentsMerchantDefinedInformation]**](Ptsv2paymentsMerchantDefinedInformation.md) | Description of this field is not available. | [optional]
1818

1919

0 commit comments

Comments
 (0)