Skip to content

Commit b49f1bb

Browse files
gnongsiegnongsie
authored
Merge pull request #125 from CyberSource/feature/mar-release-updates
Mar23 release updates
2 parents 3b94348 + 80d5a55 commit b49f1bb

File tree

1,337 files changed

+64290
-13601
lines changed

Some content is hidden

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

1,337 files changed

+64290
-13601
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ override the new secure-http default setting)*.
3131
{
3232
"require": {
3333
"php": ">=5.6",
34-
"cybersource/rest-client-php": "0.0.38"
34+
"cybersource/rest-client-php": "0.0.39"
3535
}
3636
}
3737
```

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cybersource/rest-client-php",
3-
"version": "0.0.38",
3+
"version": "0.0.39",
44
"description": "Client SDK for CyberSource REST APIs",
55
"keywords": [
66
"cybersource", "payments", "ecommerce", "merchant", "merchants", "authorize", "visa", "payment", "payment-gateway", "payment-integration", "payment-module", "payment-processing", "payment-service", "payment-methods"

‎docs/Api/BatchesApi.md‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
# CyberSource\BatchesApi
2+
3+
All URIs are relative to *https://apitest.cybersource.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getBatchReport**](BatchesApi.md#getBatchReport) | **GET** /accountupdater/v1/batches/{batchId}/report | Retrieve a Batch Report
8+
[**getBatchStatus**](BatchesApi.md#getBatchStatus) | **GET** /accountupdater/v1/batches/{batchId}/status | Retrieve a Batch Status
9+
[**getBatchesList**](BatchesApi.md#getBatchesList) | **GET** /accountupdater/v1/batches | List Batches
10+
[**postBatch**](BatchesApi.md#postBatch) | **POST** /accountupdater/v1/batches | Create a Batch
11+
12+
13+
# **getBatchReport**
14+
> \CyberSource\Model\InlineResponse20014 getBatchReport($batchId)
15+
16+
Retrieve a Batch Report
17+
18+
**Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates & card type. - Response record information including response code, reason, token ids, masked card number, expiration dates & card type.
19+
20+
### Example
21+
```php
22+
<?php
23+
require_once(__DIR__ . '/vendor/autoload.php');
24+
25+
$api_instance = new CyberSource\Api\BatchesApi();
26+
$batchId = "batchId_example"; // string | Unique identification number assigned to the submitted request.
27+
28+
try {
29+
$result = $api_instance->getBatchReport($batchId);
30+
print_r($result);
31+
} catch (Exception $e) {
32+
echo 'Exception when calling BatchesApi->getBatchReport: ', $e->getMessage(), PHP_EOL;
33+
}
34+
?>
35+
```
36+
37+
### Parameters
38+
39+
Name | Type | Description | Notes
40+
------------- | ------------- | ------------- | -------------
41+
**batchId** | **string**| Unique identification number assigned to the submitted request. |
42+
43+
### Return type
44+
45+
[**\CyberSource\Model\InlineResponse20014**](../Model/InlineResponse20014.md)
46+
47+
### Authorization
48+
49+
No authorization required
50+
51+
### HTTP request headers
52+
53+
- **Content-Type**: application/json;charset=utf-8
54+
- **Accept**: application/json;charset=utf-8
55+
56+
[[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)
57+
58+
# **getBatchStatus**
59+
> \CyberSource\Model\InlineResponse20013 getBatchStatus($batchId)
60+
61+
Retrieve a Batch Status
62+
63+
**Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)
64+
65+
### Example
66+
```php
67+
<?php
68+
require_once(__DIR__ . '/vendor/autoload.php');
69+
70+
$api_instance = new CyberSource\Api\BatchesApi();
71+
$batchId = "batchId_example"; // string | Unique identification number assigned to the submitted request.
72+
73+
try {
74+
$result = $api_instance->getBatchStatus($batchId);
75+
print_r($result);
76+
} catch (Exception $e) {
77+
echo 'Exception when calling BatchesApi->getBatchStatus: ', $e->getMessage(), PHP_EOL;
78+
}
79+
?>
80+
```
81+
82+
### Parameters
83+
84+
Name | Type | Description | Notes
85+
------------- | ------------- | ------------- | -------------
86+
**batchId** | **string**| Unique identification number assigned to the submitted request. |
87+
88+
### Return type
89+
90+
[**\CyberSource\Model\InlineResponse20013**](../Model/InlineResponse20013.md)
91+
92+
### Authorization
93+
94+
No authorization required
95+
96+
### HTTP request headers
97+
98+
- **Content-Type**: application/json;charset=utf-8
99+
- **Accept**: application/json;charset=utf-8
100+
101+
[[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)
102+
103+
# **getBatchesList**
104+
> \CyberSource\Model\InlineResponse20012 getBatchesList($offset, $limit, $fromDate, $toDate)
105+
106+
List Batches
107+
108+
**List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.
109+
110+
### Example
111+
```php
112+
<?php
113+
require_once(__DIR__ . '/vendor/autoload.php');
114+
115+
$api_instance = new CyberSource\Api\BatchesApi();
116+
$offset = 0; // int | Starting record in zero-based dataset that should be returned as the first object in the array.
117+
$limit = 20; // int | The maximum number that can be returned in the array starting from the offset record in zero-based dataset.
118+
$fromDate = "fromDate_example"; // string | ISO-8601 format: yyyyMMddTHHmmssZ
119+
$toDate = "toDate_example"; // string | ISO-8601 format: yyyyMMddTHHmmssZ
120+
121+
try {
122+
$result = $api_instance->getBatchesList($offset, $limit, $fromDate, $toDate);
123+
print_r($result);
124+
} catch (Exception $e) {
125+
echo 'Exception when calling BatchesApi->getBatchesList: ', $e->getMessage(), PHP_EOL;
126+
}
127+
?>
128+
```
129+
130+
### Parameters
131+
132+
Name | Type | Description | Notes
133+
------------- | ------------- | ------------- | -------------
134+
**offset** | **int**| Starting record in zero-based dataset that should be returned as the first object in the array. | [optional] [default to 0]
135+
**limit** | **int**| The maximum number that can be returned in the array starting from the offset record in zero-based dataset. | [optional] [default to 20]
136+
**fromDate** | **string**| ISO-8601 format: yyyyMMddTHHmmssZ | [optional]
137+
**toDate** | **string**| ISO-8601 format: yyyyMMddTHHmmssZ | [optional]
138+
139+
### Return type
140+
141+
[**\CyberSource\Model\InlineResponse20012**](../Model/InlineResponse20012.md)
142+
143+
### Authorization
144+
145+
No authorization required
146+
147+
### HTTP request headers
148+
149+
- **Content-Type**: application/json;charset=utf-8
150+
- **Accept**: application/json;charset=utf-8
151+
152+
[[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)
153+
154+
# **postBatch**
155+
> \CyberSource\Model\InlineResponse2022 postBatch($body)
156+
157+
Create a Batch
158+
159+
**Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report.
160+
161+
### Example
162+
```php
163+
<?php
164+
require_once(__DIR__ . '/vendor/autoload.php');
165+
166+
$api_instance = new CyberSource\Api\BatchesApi();
167+
$body = new \CyberSource\Model\Body(); // \CyberSource\Model\Body |
168+
169+
try {
170+
$result = $api_instance->postBatch($body);
171+
print_r($result);
172+
} catch (Exception $e) {
173+
echo 'Exception when calling BatchesApi->postBatch: ', $e->getMessage(), PHP_EOL;
174+
}
175+
?>
176+
```
177+
178+
### Parameters
179+
180+
Name | Type | Description | Notes
181+
------------- | ------------- | ------------- | -------------
182+
**body** | [**\CyberSource\Model\Body**](../Model/Body.md)| |
183+
184+
### Return type
185+
186+
[**\CyberSource\Model\InlineResponse2022**](../Model/InlineResponse2022.md)
187+
188+
### Authorization
189+
190+
No authorization required
191+
192+
### HTTP request headers
193+
194+
- **Content-Type**: application/json;charset=utf-8
195+
- **Accept**: application/json;charset=utf-8
196+
197+
[[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)
198+

0 commit comments

Comments
 (0)