Skip to content

Commit b692ed5

Browse files
sachshetsachshet
authored
Merge pull request #106 from CyberSource/feature/jan-release-updates
Feature/jan release updates
2 parents 9a88847 + 45b61dd commit b692ed5

File tree

310 files changed

+18272
-459
lines changed

Some content is hidden

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

310 files changed

+18272
-459
lines changed

‎docs/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**type** | **String** | Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional]
7-
**amount** | **String** | Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | | ------------- |:-------------:| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of value added tax (VAT) included in the order. | | `other` | Other tax. | | [optional]
6+
**type** | **String** | Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional]
7+
**amount** | **String** | Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | | ------------- |:-------------:| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of value added tax (VAT) included in the order. | | `other` | Other tax. | | `green` | Green tax amount for Korean Processing. | | [optional]
88
**rate** | **String** | Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional]
99

1010

‎docs/PaymentsApi.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**createPayment**](PaymentsApi.md#createPayment) | **POST** /pts/v2/payments | Process a Payment
88
[**incrementAuth**](PaymentsApi.md#incrementAuth) | **PATCH** /pts/v2/payments/{id} | Increment an Authorization
9+
[**refreshPaymentStatus**](PaymentsApi.md#refreshPaymentStatus) | **POST** /pts/v2/refresh-payment-status/{id} | Check a Payment Status
910

1011

1112
<a name="createPayment"></a>
@@ -103,3 +104,52 @@ No authorization required
103104
- **Content-Type**: application/json;charset=utf-8
104105
- **Accept**: application/hal+json;charset=utf-8
105106

107+
<a name="refreshPaymentStatus"></a>
108+
# **refreshPaymentStatus**
109+
> PtsV2PaymentsPost201Response1 refreshPaymentStatus(id, refreshPaymentStatusRequest)
110+
111+
Check a Payment Status
112+
113+
Checks and updates the payment status
114+
115+
### Example
116+
```javascript
117+
var CyberSource = require('CyberSource');
118+
119+
var apiInstance = new CyberSource.PaymentsApi();
120+
121+
var id = "id_example"; // String | The payment id whose status needs to be checked and updated.
122+
123+
var refreshPaymentStatusRequest = new CyberSource.RefreshPaymentStatusRequest(); // RefreshPaymentStatusRequest |
124+
125+
126+
var callback = function(error, data, response) {
127+
if (error) {
128+
console.error(error);
129+
} else {
130+
console.log('API called successfully. Returned data: ' + data);
131+
}
132+
};
133+
apiInstance.refreshPaymentStatus(id, refreshPaymentStatusRequest, callback);
134+
```
135+
136+
### Parameters
137+
138+
Name | Type | Description | Notes
139+
------------- | ------------- | ------------- | -------------
140+
**id** | **String**| The payment id whose status needs to be checked and updated. |
141+
**refreshPaymentStatusRequest** | [**RefreshPaymentStatusRequest**](RefreshPaymentStatusRequest.md)| |
142+
143+
### Return type
144+
145+
[**PtsV2PaymentsPost201Response1**](PtsV2PaymentsPost201Response1.md)
146+
147+
### Authorization
148+
149+
No authorization required
150+
151+
### HTTP request headers
152+
153+
- **Content-Type**: application/json;charset=utf-8
154+
- **Accept**: application/hal+json;charset=utf-8
155+

‎docs/PtsV2PaymentsPost201Response1.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CyberSource.PtsV2PaymentsPost201Response1
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
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+
**status** | **String** | The status of the submitted transaction. Possible values: - AUTHORIZED - PARTIAL_AUTHORIZED - AUTHORIZED_PENDING_REVIEW - AUTHORIZED_RISK_DECLINED - PENDING_AUTHENTICATION - PENDING_REVIEW - DECLINED - INVALID_REQUEST | [optional]
8+
**submitTimeUtc** | **String** | Time of request in UTC. Format: &#x60;YYYY-MM-DDThh:mm:ssZ&#x60; **Example** &#x60;2016-08-11T22:47:57Z&#x60; equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The &#x60;T&#x60; separates the date and the time. The &#x60;Z&#x60; indicates UTC. Returned by Cybersource for all services. | [optional]
9+
**processorInformation** | [**PtsV2PaymentsPost201Response1ProcessorInformation**](PtsV2PaymentsPost201Response1ProcessorInformation.md) | | [optional]
10+
**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]
11+
**paymentInformation** | [**PtsV2PaymentsPost201Response1PaymentInformation**](PtsV2PaymentsPost201Response1PaymentInformation.md) | | [optional]
12+
**orderInformation** | [**PtsV2PaymentsPost201Response1OrderInformation**](PtsV2PaymentsPost201Response1OrderInformation.md) | | [optional]
13+
**clientReferenceInformation** | [**PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation**](PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation.md) | | [optional]
14+
15+

‎docs/PtsV2PaymentsPost201Response1OrderInformation.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CyberSource.PtsV2PaymentsPost201Response1OrderInformation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**billTo** | [**PtsV2PaymentsPost201Response1OrderInformationBillTo**](PtsV2PaymentsPost201Response1OrderInformationBillTo.md) | | [optional]
7+
**shipTo** | [**PtsV2PaymentsPost201Response1OrderInformationShipTo**](PtsV2PaymentsPost201Response1OrderInformationShipTo.md) | | [optional]
8+
9+

0 commit comments

Comments
 (0)