cybersource-rest-client
Version:
Node.js SDK for the CyberSource REST API
103 lines (66 loc) • 2.59 kB
Markdown
# CyberSource.SearchTransactionsApi
All URIs are relative to *https://apitest.cybersource.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createSearch**](SearchTransactionsApi.md#createSearch) | **POST** /tss/v2/searches | Create a Search Request
[**getSearch**](SearchTransactionsApi.md#getSearch) | **GET** /tss/v2/searches/{searchId} | Get Search Results
<a name="createSearch"></a>
# **createSearch**
> TssV2TransactionsPost201Response createSearch(createSearchRequest)
Create a Search Request
Create a search request.
### Example
```javascript
var CyberSource = require('CyberSource');
var apiInstance = new CyberSource.SearchTransactionsApi();
var createSearchRequest = new CyberSource.CreateSearchRequest(); // CreateSearchRequest |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.createSearch(createSearchRequest, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**createSearchRequest** | [**CreateSearchRequest**](CreateSearchRequest.md)| |
### Return type
[**TssV2TransactionsPost201Response**](TssV2TransactionsPost201Response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/json;charset=utf-8
<a name="getSearch"></a>
# **getSearch**
> TssV2TransactionsPost201Response getSearch(searchId)
Get Search Results
Include the Search ID in the GET request to retrieve the search results.
### Example
```javascript
var CyberSource = require('CyberSource');
var apiInstance = new CyberSource.SearchTransactionsApi();
var searchId = "searchId_example"; // String | Search ID.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getSearch(searchId, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**searchId** | **String**| Search ID. |
### Return type
[**TssV2TransactionsPost201Response**](TssV2TransactionsPost201Response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json;charset=utf-8
- **Accept**: */*