Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ override the new secure-http default setting)*.
{
"require": {
"php": ">=8.0.0",
"cybersource/rest-client-php": "0.0.66"
"cybersource/rest-client-php": "0.0.67"
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cybersource/rest-client-php",
"version": "0.0.66",
"version": "0.0.67",
"description": "Client SDK for CyberSource REST APIs",
"keywords": [
"cybersource", "payments", "ecommerce", "merchant", "merchants", "authorize", "visa", "payment", "payment-gateway", "payment-integration", "payment-module", "payment-processing", "payment-service", "payment-methods"
Expand Down
58 changes: 29 additions & 29 deletions docs/Api/MerchantDefinedFieldsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ All URIs are relative to *https://apitest.cybersource.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createMerchantDefinedFieldDefinition**](MerchantDefinedFieldsApi.md#createMerchantDefinedFieldDefinition) | **POST** /invoicing/v2/{referenceType}/merchantDefinedFields | Create merchant defined field for a given reference type
[**deleteMerchantDefinedFieldsDefinitions**](MerchantDefinedFieldsApi.md#deleteMerchantDefinedFieldsDefinitions) | **DELETE** /invoicing/v2/{referenceType}/merchantDefinedFields/{id} | Delete a MerchantDefinedField by ID
[**getMerchantDefinedFieldsDefinitions**](MerchantDefinedFieldsApi.md#getMerchantDefinedFieldsDefinitions) | **GET** /invoicing/v2/{referenceType}/merchantDefinedFields | Get all merchant defined fields for a given reference type
[**invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete**](MerchantDefinedFieldsApi.md#invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete) | **DELETE** /invoicing/v2/{referenceType}/merchantDefinedFields/{id} | Delete a MerchantDefinedField by ID
[**invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut**](MerchantDefinedFieldsApi.md#invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut) | **PUT** /invoicing/v2/{referenceType}/merchantDefinedFields/{id} | Update a MerchantDefinedField by ID
[**putMerchantDefinedFieldsDefinitions**](MerchantDefinedFieldsApi.md#putMerchantDefinedFieldsDefinitions) | **PUT** /invoicing/v2/{referenceType}/merchantDefinedFields/{id} | Update a MerchantDefinedField by ID


# **createMerchantDefinedFieldDefinition**
Expand Down Expand Up @@ -55,24 +55,24 @@ No authorization required

[[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)

# **getMerchantDefinedFieldsDefinitions**
> \CyberSource\Model\InlineResponse2002[] getMerchantDefinedFieldsDefinitions($referenceType)
# **deleteMerchantDefinedFieldsDefinitions**
> deleteMerchantDefinedFieldsDefinitions($referenceType, $id)

Get all merchant defined fields for a given reference type
Delete a MerchantDefinedField by ID

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new CyberSource\Api\MerchantDefinedFieldsApi();
$referenceType = "referenceType_example"; // string | The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation
$referenceType = "referenceType_example"; // string |
$id = 789; // int |

try {
$result = $api_instance->getMerchantDefinedFieldsDefinitions($referenceType);
print_r($result);
$api_instance->deleteMerchantDefinedFieldsDefinitions($referenceType, $id);
} catch (Exception $e) {
echo 'Exception when calling MerchantDefinedFieldsApi->getMerchantDefinedFieldsDefinitions: ', $e->getMessage(), PHP_EOL;
echo 'Exception when calling MerchantDefinedFieldsApi->deleteMerchantDefinedFieldsDefinitions: ', $e->getMessage(), PHP_EOL;
}
?>
```
Expand All @@ -81,41 +81,42 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**referenceType** | **string**| The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation |
**referenceType** | **string**| |
**id** | **int**| |

### Return type

[**\CyberSource\Model\InlineResponse2002[]**](../Model/InlineResponse2002.md)
void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json
- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/hal+json;charset=utf-8

[[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)

# **invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete**
> invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete($referenceType, $id)
# **getMerchantDefinedFieldsDefinitions**
> \CyberSource\Model\InlineResponse2002[] getMerchantDefinedFieldsDefinitions($referenceType)

Delete a MerchantDefinedField by ID
Get all merchant defined fields for a given reference type

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new CyberSource\Api\MerchantDefinedFieldsApi();
$referenceType = "referenceType_example"; // string |
$id = 789; // int |
$referenceType = "referenceType_example"; // string | The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation

try {
$api_instance->invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete($referenceType, $id);
$result = $api_instance->getMerchantDefinedFieldsDefinitions($referenceType);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling MerchantDefinedFieldsApi->invoicingV2ReferenceTypeMerchantDefinedFieldsIdDelete: ', $e->getMessage(), PHP_EOL;
echo 'Exception when calling MerchantDefinedFieldsApi->getMerchantDefinedFieldsDefinitions: ', $e->getMessage(), PHP_EOL;
}
?>
```
Expand All @@ -124,26 +125,25 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**referenceType** | **string**| |
**id** | **int**| |
**referenceType** | **string**| The reference type for which merchant defined fields are to be fetched. Available values are Invoice, Purchase, Donation |

### Return type

void (empty response body)
[**\CyberSource\Model\InlineResponse2002[]**](../Model/InlineResponse2002.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/hal+json;charset=utf-8
- **Content-Type**: application/json
- **Accept**: application/json

[[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)

# **invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut**
> \CyberSource\Model\InlineResponse2002[] invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut($referenceType, $id, $merchantDefinedFieldCore)
# **putMerchantDefinedFieldsDefinitions**
> \CyberSource\Model\InlineResponse2002[] putMerchantDefinedFieldsDefinitions($referenceType, $id, $merchantDefinedFieldCore)

Update a MerchantDefinedField by ID

Expand All @@ -158,10 +158,10 @@ $id = 789; // int |
$merchantDefinedFieldCore = new \CyberSource\Model\MerchantDefinedFieldCore(); // \CyberSource\Model\MerchantDefinedFieldCore |

try {
$result = $api_instance->invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut($referenceType, $id, $merchantDefinedFieldCore);
$result = $api_instance->putMerchantDefinedFieldsDefinitions($referenceType, $id, $merchantDefinedFieldCore);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling MerchantDefinedFieldsApi->invoicingV2ReferenceTypeMerchantDefinedFieldsIdPut: ', $e->getMessage(), PHP_EOL;
echo 'Exception when calling MerchantDefinedFieldsApi->putMerchantDefinedFieldsDefinitions: ', $e->getMessage(), PHP_EOL;
}
?>
```
Expand Down
120 changes: 120 additions & 0 deletions docs/Api/OffersApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# CyberSource\OffersApi

All URIs are relative to *https://apitest.cybersource.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createOffer**](OffersApi.md#createOffer) | **POST** /vas/v1/currencyconversion | Create an Offer
[**getOffer**](OffersApi.md#getOffer) | **GET** /vas/v1/currencyconversion/{id} | Retrieve an Offer


# **createOffer**
> \CyberSource\Model\InlineResponse2018 createOffer($contentType, $xRequestid, $vCMerchantId, $vCCorrelationId, $vCOrganizationId, $offerRequest)

Create an Offer

Creates an offer record on the provider system.

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new CyberSource\Api\OffersApi();
$contentType = "contentType_example"; // string |
$xRequestid = "xRequestid_example"; // string |
$vCMerchantId = "vCMerchantId_example"; // string |
$vCCorrelationId = "vCCorrelationId_example"; // string |
$vCOrganizationId = "vCOrganizationId_example"; // string |
$offerRequest = new \CyberSource\Model\OfferRequest(); // \CyberSource\Model\OfferRequest |

try {
$result = $api_instance->createOffer($contentType, $xRequestid, $vCMerchantId, $vCCorrelationId, $vCOrganizationId, $offerRequest);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OffersApi->createOffer: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contentType** | **string**| |
**xRequestid** | **string**| |
**vCMerchantId** | **string**| |
**vCCorrelationId** | **string**| |
**vCOrganizationId** | **string**| |
**offerRequest** | [**\CyberSource\Model\OfferRequest**](../Model/OfferRequest.md)| |

### Return type

[**\CyberSource\Model\InlineResponse2018**](../Model/InlineResponse2018.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/hal+json;charset=utf-8

[[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)

# **getOffer**
> \CyberSource\Model\InlineResponse20014 getOffer($contentType, $xRequestid, $vCMerchantId, $vCCorrelationId, $vCOrganizationId, $id)

Retrieve an Offer

Retrieves an offer record from the system.

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new CyberSource\Api\OffersApi();
$contentType = "contentType_example"; // string |
$xRequestid = "xRequestid_example"; // string |
$vCMerchantId = "vCMerchantId_example"; // string |
$vCCorrelationId = "vCCorrelationId_example"; // string |
$vCOrganizationId = "vCOrganizationId_example"; // string |
$id = "id_example"; // string | Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id

try {
$result = $api_instance->getOffer($contentType, $xRequestid, $vCMerchantId, $vCCorrelationId, $vCOrganizationId, $id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OffersApi->getOffer: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contentType** | **string**| |
**xRequestid** | **string**| |
**vCMerchantId** | **string**| |
**vCCorrelationId** | **string**| |
**vCOrganizationId** | **string**| |
**id** | **string**| Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id |

### Return type

[**\CyberSource\Model\InlineResponse20014**](../Model/InlineResponse20014.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/hal+json;charset=utf-8

[[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)

2 changes: 1 addition & 1 deletion docs/Api/TokenApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ No authorization required

Generate Payment Credentials for a TMS Token

| | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier.
| | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful.

### Example
```php
Expand Down
49 changes: 0 additions & 49 deletions docs/Api/TokenizedCardApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**deleteTokenizedCard**](TokenizedCardApi.md#deleteTokenizedCard) | **DELETE** /tms/v2/tokenized-cards/{tokenizedCardId} | Delete a Tokenized Card
[**getTokenizedCard**](TokenizedCardApi.md#getTokenizedCard) | **GET** /tms/v2/tokenized-cards/{tokenizedCardId} | Retrieve a Tokenized Card
[**postIssuerLifeCycleSimulation**](TokenizedCardApi.md#postIssuerLifeCycleSimulation) | **POST** /tms/v2/tokenized-cards/{tokenizedCardId}/issuer-life-cycle-event-simulations | Simulate Issuer Life Cycle Management Events
[**postTokenizedCard**](TokenizedCardApi.md#postTokenizedCard) | **POST** /tms/v2/tokenized-cards | Create a Tokenized Card


Expand Down Expand Up @@ -103,54 +102,6 @@ No authorization required

[[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)

# **postIssuerLifeCycleSimulation**
> postIssuerLifeCycleSimulation($profileId, $tokenizedCardId, $postIssuerLifeCycleSimulationRequest)

Simulate Issuer Life Cycle Management Events

**Lifecycle Management Events**<br>Simulates an issuer life cycle manegement event for updates on the tokenized card. The events that can be simulated are: - Token status changes (e.g. active, suspended, deleted) - Updates to the underlying card, including card art changes, expiration date changes, and card number suffix. **Note:** This is only available in CAS environment.

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new CyberSource\Api\TokenizedCardApi();
$profileId = "profileId_example"; // string | The Id of a profile containing user specific TMS configuration.
$tokenizedCardId = "tokenizedCardId_example"; // string | The Id of a tokenized card.
$postIssuerLifeCycleSimulationRequest = new \CyberSource\Model\PostIssuerLifeCycleSimulationRequest(); // \CyberSource\Model\PostIssuerLifeCycleSimulationRequest |

try {
$api_instance->postIssuerLifeCycleSimulation($profileId, $tokenizedCardId, $postIssuerLifeCycleSimulationRequest);
} catch (Exception $e) {
echo 'Exception when calling TokenizedCardApi->postIssuerLifeCycleSimulation: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**profileId** | **string**| The Id of a profile containing user specific TMS configuration. |
**tokenizedCardId** | **string**| The Id of a tokenized card. |
**postIssuerLifeCycleSimulationRequest** | [**\CyberSource\Model\PostIssuerLifeCycleSimulationRequest**](../Model/PostIssuerLifeCycleSimulationRequest.md)| |

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/json;charset=utf-8

[[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)

# **postTokenizedCard**
> \CyberSource\Model\TokenizedcardRequest postTokenizedCard($tokenizedcardRequest, $profileId)

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/CapturePaymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Name | Type | Description | Notes
**installmentInformation** | [**\CyberSource\Model\Ptsv2paymentsidcapturesInstallmentInformation**](Ptsv2paymentsidcapturesInstallmentInformation.md) | | [optional]
**travelInformation** | [**\CyberSource\Model\Ptsv2paymentsTravelInformation**](Ptsv2paymentsTravelInformation.md) | | [optional]
**promotionInformation** | [**\CyberSource\Model\Ptsv2paymentsPromotionInformation**](Ptsv2paymentsPromotionInformation.md) | | [optional]
**processorInformation** | [**\CyberSource\Model\Ptsv2reversalsProcessorInformation**](Ptsv2reversalsProcessorInformation.md) | | [optional]
**processorInformation** | [**\CyberSource\Model\Ptsv2paymentsidcapturesProcessorInformation**](Ptsv2paymentsidcapturesProcessorInformation.md) | | [optional]

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

Expand Down
Loading